ai.djl.engine

Class Engine

java.lang.Object

ai.djl.engine.Engine

public abstract class Engine
extends java.lang.Object

The Engine interface is the base of the provided implementation for DJL.

Any engine-specific functionality should be provided through this class. In general, it should contain methods to detect information about the usable machine hardware and to create a new NDManager and Model.

See Also:

EngineProvider

Constructor Summary

Constructors

Constructor and Description
Engine()

Method Summary

Modifier and Type	Method and Description
void	debugEnvironment() Logs debug information about the environment for use when debugging environment issues.
static java.util.Collection<Engine>	getAllEngines() Returns a Collection of engines that are loaded.
static Engine	getEngine(java.lang.String engineName) Returns the Engine with the given name.
abstract java.lang.String	getEngineName() Returns the name of the Engine.
static Engine	getInstance() Returns the default Engine.
abstract java.lang.String	getVersion() Returns the version of the deep learning engine.
abstract boolean	hasCapability(java.lang.String capability) Returns whether the engine has the specified capability.
static boolean	hasEngine(java.lang.String engineName) Returns if the specified engine is available.
abstract NDManager	newBaseManager() Creates a new top-level NDManager.
abstract NDManager	newBaseManager(Device device) Creates a new top-level NDManager with specified Device.
abstract GradientCollector	newGradientCollector() Returns a new instance of GradientCollector.
abstract Model	newModel(java.lang.String name, Device device) Constructs a new model.
ParameterServer	newParameterServer(Optimizer optimizer) Returns a new instance of ParameterServer.
abstract void	setRandomSeed(int seed) Seeds the random number generator in DJL Engine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Engine

public Engine()

Method Detail

getEngineName

public abstract java.lang.String getEngineName()

Returns the name of the Engine.

Returns:

the name of the engine

getInstance

public static Engine getInstance()

Returns the default Engine.

Returns:

the instance of Engine

See Also:

EngineProvider

hasEngine

public static boolean hasEngine(java.lang.String engineName)

Returns if the specified engine is available.

Parameters:

engineName - the name of Engine to check

Returns:

true if the specified engine is available

See Also:

EngineProvider

getAllEngines

public static java.util.Collection<Engine> getAllEngines()

Returns a Collection of engines that are loaded.

Returns:

Collection<Engine> that are supported

getEngine

public static Engine getEngine(java.lang.String engineName)

Returns the Engine with the given name.

Parameters:

engineName - the name of Engine to retrieve

Returns:

the instance of Engine

See Also:

EngineProvider

getVersion

public abstract java.lang.String getVersion()

Returns the version of the deep learning engine.

Returns:

the version number of the deep learning engine

hasCapability

public abstract boolean hasCapability(java.lang.String capability)

Returns whether the engine has the specified capability.

Parameters:

capability - the capability to retrieve

Returns:

true if the engine has the specified capability

newModel

public abstract Model newModel(java.lang.String name,
                               Device device)

Constructs a new model.

Parameters:

name - the model name

device - the device that the model will be loaded onto

Returns:

a new Model instance using the network defined in block

newBaseManager

public abstract NDManager newBaseManager()

Creates a new top-level NDManager.

NDManager will inherit default Device.

Returns:

a new top-level NDManager

newBaseManager

public abstract NDManager newBaseManager(Device device)

Creates a new top-level NDManager with specified Device.

Parameters:

device - the default Device

Returns:

a new top-level NDManager

newGradientCollector

public abstract GradientCollector newGradientCollector()

Returns a new instance of GradientCollector.

Returns:

a new instance of GradientCollector

newParameterServer

public ParameterServer newParameterServer(Optimizer optimizer)

Returns a new instance of ParameterServer.

Parameters:

optimizer - the optimizer to update

Returns:

a new instance of ParameterServer

setRandomSeed

public abstract void setRandomSeed(int seed)

Seeds the random number generator in DJL Engine.

This will affect all Devices and all operators using Engine's random number generator.

Parameters:

seed - the seed to be fixed in Engine

debugEnvironment

public void debugEnvironment()

Logs debug information about the environment for use when debugging environment issues.