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 framework-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
abstract Device	defaultDevice() Returns the system's default device.
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.
abstract int	getGpuCount() Returns the number of GPUs available in the system.
abstract java.lang.management.MemoryUsage	getGpuMemory(Device device) Returns the MemoryUsage of the specified GPU device.
static Engine	getInstance() Returns the default Engine.
abstract java.lang.String	getVersion() Returns the version of the deep learning framework.
abstract NDManager	newBaseManager() Creates a new top-level NDManager.
abstract NDManager	newBaseManager(Device device) Creates a new top-level NDManager with specified Device.
abstract Model	newModel(Device device) Constructs a new model.

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

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

getGpuCount

public abstract int getGpuCount()

Returns the number of GPUs available in the system.

Returns:

the number of GPUs available in the system

getGpuMemory

public abstract java.lang.management.MemoryUsage getGpuMemory(Device device)

Returns the MemoryUsage of the specified GPU device.

Parameters:

device - the GPU Device to retrieve

Returns:

the MemoryUsage of the specified GPU device

Throws:

EngineException - if operation is not supported

java.lang.IllegalArgumentException - if Device is not GPU device

defaultDevice

public abstract Device defaultDevice()

Returns the system's default device.

If the system has GPU available, then the default device is Device.gpu(). Otherwise, the default device returned is Device.cpu()

Returns:

the system's default device

getVersion

public abstract java.lang.String getVersion()

Returns the version of the deep learning framework.

Returns:

the version number of the deep learning framework

newModel

public abstract Model newModel(Device device)

Constructs a new model.

Parameters:

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