ai.djl

Class Device

java.lang.Object

ai.djl.Device

public final class Device
extends java.lang.Object

The Device class provides the specified assignment for CPU/GPU processing on the NDArray.

Users can use this to specify whether to load/compute the NDArray on CPU/GPU with deviceType and deviceId provided.

See Also:

The D2L chapter on GPU devices

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Device.Type Contains device type string constants.

Method Summary

Modifier and Type	Method and Description
static Device	cpu() Returns the default CPU Device.
boolean	equals(java.lang.Object o)
int	getDeviceId() Returns the deviceId of the Device.
java.lang.String	getDeviceType() Returns the device type of the Device.
static Device	gpu() Returns the default GPU Device.
static Device	gpu(int deviceId) Returns a new instance of GPU Device with the specified deviceId.
int	hashCode()
boolean	isGpu() Returns if the Device is GPU.
static Device	of(java.lang.String deviceType, int deviceId) Returns a Device with device type and device id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static Device of(java.lang.String deviceType,
                        int deviceId)

Returns a Device with device type and device id.

Parameters:

deviceType - the device type, typically CPU or GPU

deviceId - the deviceId on the hardware.

Returns:

a Device instance

getDeviceType

public java.lang.String getDeviceType()

Returns the device type of the Device.

Returns:

the device type of the Device

getDeviceId

public int getDeviceId()

Returns the deviceId of the Device.

Returns:

the deviceId of the Device

isGpu

public boolean isGpu()

Returns if the Device is GPU.

Returns:

if the Device is GPU.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

cpu

public static Device cpu()

Returns the default CPU Device.

Returns:

the default CPU Device

gpu

public static Device gpu()

Returns the default GPU Device.

Returns:

the default GPU Device

gpu

public static Device gpu(int deviceId)

Returns a new instance of GPU Device with the specified deviceId.

Parameters:

deviceId - the GPU device ID

Returns:

a new instance of GPU Device with specified deviceId