ai.djl.mxnet.engine

Class MxNDManager

java.lang.Object

ai.djl.mxnet.engine.MxNDManager

All Implemented Interfaces:

ai.djl.ndarray.NDManager, java.lang.AutoCloseable

public class MxNDManager
extends java.lang.Object
implements ai.djl.ndarray.NDManager

MxNDManager is the MXNet implementation of NDManager.

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	allocateDirect(int capacity)
ai.djl.ndarray.NDArray	arange(java.lang.Number start, java.lang.Number stop, java.lang.Number step, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
void	attach(java.lang.String resourceId, java.lang.AutoCloseable resource)
void	close()
MxNDArray	create(com.sun.jna.Pointer handle) Creates an MxNDArray with the given Native Memory Pointer and attaches to this manager.
MxSparseNDArray	create(com.sun.jna.Pointer handle, ai.djl.ndarray.types.SparseFormat fmt) Creates a sparse MxNDArray with the given Native Memory Pointer and attaches to this manager.
MxNDArray	create(ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
MxSparseNDArray	createCSR(java.nio.Buffer data, long[] indptr, long[] indices, ai.djl.ndarray.types.Shape shape, ai.djl.Device dev)
MxSparseNDArray	createRowSparse(java.nio.Buffer data, ai.djl.ndarray.types.Shape dataShape, long[] indices, ai.djl.ndarray.types.Shape shape, ai.djl.Device dev)
void	debugDump(int level) Prints information about this NDManager and all sub-managers to the console.
void	detach(java.lang.String resourceId)
ai.djl.ndarray.NDArray	eye(int rows, int cols, int k, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
ai.djl.Device	getDevice()
ai.djl.ndarray.NDManager	getParentManager()
void	invoke(java.lang.String operation, ai.djl.ndarray.NDArray[] src, ai.djl.ndarray.NDArray[] dest, ai.djl.util.PairList<java.lang.String,?> params)
ai.djl.ndarray.NDArray	invoke(java.lang.String operation, ai.djl.ndarray.NDArray[] src, ai.djl.util.PairList<java.lang.String,?> params) An engine specific generic invocation to native operator.
ai.djl.ndarray.NDArray	invoke(java.lang.String operation, ai.djl.ndarray.NDArray src, ai.djl.util.PairList<java.lang.String,?> params) An engine specific generic invocation to native operator.
void	invoke(java.lang.String operation, ai.djl.ndarray.NDList src, ai.djl.ndarray.NDList dest, ai.djl.util.PairList<java.lang.String,?> params) An engine specific generic invocation to native operator.
ai.djl.ndarray.NDList	invoke(java.lang.String operation, ai.djl.ndarray.NDList src, ai.djl.util.PairList<java.lang.String,?> params)
ai.djl.ndarray.NDArray	invoke(java.lang.String operation, ai.djl.util.PairList<java.lang.String,?> params) An engine specific generic invocation to native operator.
ai.djl.ndarray.NDArray	linspace(java.lang.Number start, java.lang.Number stop, int num, boolean endpoint, ai.djl.Device dev)
MxNDManager	newSubManager()
MxNDManager	newSubManager(ai.djl.Device dev)
ai.djl.ndarray.NDArray	ones(ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
ai.djl.ndarray.NDArray	randomMultinomial(int n, ai.djl.ndarray.NDArray pValues)
ai.djl.ndarray.NDArray	randomMultinomial(int n, ai.djl.ndarray.NDArray pValues, ai.djl.ndarray.types.Shape shape)
ai.djl.ndarray.NDArray	randomNormal(java.lang.Number loc, java.lang.Number scale, ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
ai.djl.ndarray.NDArray	randomUniform(java.lang.Number low, java.lang.Number high, ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)
java.lang.String	toString()
ai.djl.ndarray.NDArray	zeros(ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType, ai.djl.Device dev)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.ndarray.NDManager

arange, arange, arange, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, createCSR, createRowSparse, eye, eye, eye, linspace, newBaseManager, newBaseManager, ones, ones, randomNormal, randomNormal, randomUniform, zeros, zeros

Method Detail

allocateDirect

public java.nio.ByteBuffer allocateDirect(int capacity)

Specified by:

allocateDirect in interface ai.djl.ndarray.NDManager

create

public MxNDArray create(com.sun.jna.Pointer handle)

Creates an MxNDArray with the given Native Memory Pointer and attaches to this manager.

Parameters:

handle - the array's native memory pointer

Returns:

the created array

create

public MxSparseNDArray create(com.sun.jna.Pointer handle,
                              ai.djl.ndarray.types.SparseFormat fmt)

Creates a sparse MxNDArray with the given Native Memory Pointer and attaches to this manager.

Parameters:

handle - the array's native memory pointer

fmt - the sparse format to use

Returns:

the created array

create

public MxNDArray create(ai.djl.ndarray.types.Shape shape,
                        ai.djl.ndarray.types.DataType dataType,
                        ai.djl.Device dev)

Specified by:

create in interface ai.djl.ndarray.NDManager

createCSR

public MxSparseNDArray createCSR(java.nio.Buffer data,
                                 long[] indptr,
                                 long[] indices,
                                 ai.djl.ndarray.types.Shape shape,
                                 ai.djl.Device dev)

Specified by:

createCSR in interface ai.djl.ndarray.NDManager

createRowSparse

public MxSparseNDArray createRowSparse(java.nio.Buffer data,
                                       ai.djl.ndarray.types.Shape dataShape,
                                       long[] indices,
                                       ai.djl.ndarray.types.Shape shape,
                                       ai.djl.Device dev)

Specified by:

createRowSparse in interface ai.djl.ndarray.NDManager

zeros

public ai.djl.ndarray.NDArray zeros(ai.djl.ndarray.types.Shape shape,
                                    ai.djl.ndarray.types.DataType dataType,
                                    ai.djl.Device dev)

Specified by:

zeros in interface ai.djl.ndarray.NDManager

ones

public ai.djl.ndarray.NDArray ones(ai.djl.ndarray.types.Shape shape,
                                   ai.djl.ndarray.types.DataType dataType,
                                   ai.djl.Device dev)

Specified by:

ones in interface ai.djl.ndarray.NDManager

arange

public ai.djl.ndarray.NDArray arange(java.lang.Number start,
                                     java.lang.Number stop,
                                     java.lang.Number step,
                                     ai.djl.ndarray.types.DataType dataType,
                                     ai.djl.Device dev)

Specified by:

arange in interface ai.djl.ndarray.NDManager

eye

public ai.djl.ndarray.NDArray eye(int rows,
                                  int cols,
                                  int k,
                                  ai.djl.ndarray.types.DataType dataType,
                                  ai.djl.Device dev)

Specified by:

eye in interface ai.djl.ndarray.NDManager

linspace

public ai.djl.ndarray.NDArray linspace(java.lang.Number start,
                                       java.lang.Number stop,
                                       int num,
                                       boolean endpoint,
                                       ai.djl.Device dev)

Specified by:

linspace in interface ai.djl.ndarray.NDManager

randomUniform

public ai.djl.ndarray.NDArray randomUniform(java.lang.Number low,
                                            java.lang.Number high,
                                            ai.djl.ndarray.types.Shape shape,
                                            ai.djl.ndarray.types.DataType dataType,
                                            ai.djl.Device dev)

Specified by:

randomUniform in interface ai.djl.ndarray.NDManager

randomNormal

public ai.djl.ndarray.NDArray randomNormal(java.lang.Number loc,
                                           java.lang.Number scale,
                                           ai.djl.ndarray.types.Shape shape,
                                           ai.djl.ndarray.types.DataType dataType,
                                           ai.djl.Device dev)

Specified by:

randomNormal in interface ai.djl.ndarray.NDManager

randomMultinomial

public ai.djl.ndarray.NDArray randomMultinomial(int n,
                                                ai.djl.ndarray.NDArray pValues,
                                                ai.djl.ndarray.types.Shape shape)

Specified by:

randomMultinomial in interface ai.djl.ndarray.NDManager

randomMultinomial

public ai.djl.ndarray.NDArray randomMultinomial(int n,
                                                ai.djl.ndarray.NDArray pValues)

Specified by:

randomMultinomial in interface ai.djl.ndarray.NDManager

getParentManager

public ai.djl.ndarray.NDManager getParentManager()

Specified by:

getParentManager in interface ai.djl.ndarray.NDManager

newSubManager

public MxNDManager newSubManager()

Specified by:

newSubManager in interface ai.djl.ndarray.NDManager

newSubManager

public MxNDManager newSubManager(ai.djl.Device dev)

Specified by:

newSubManager in interface ai.djl.ndarray.NDManager

getDevice

public ai.djl.Device getDevice()

Specified by:

getDevice in interface ai.djl.ndarray.NDManager

attach

public void attach(java.lang.String resourceId,
                   java.lang.AutoCloseable resource)

Specified by:

attach in interface ai.djl.ndarray.NDManager

detach

public void detach(java.lang.String resourceId)

Specified by:

detach in interface ai.djl.ndarray.NDManager

invoke

public void invoke(java.lang.String operation,
                   ai.djl.ndarray.NDArray[] src,
                   ai.djl.ndarray.NDArray[] dest,
                   ai.djl.util.PairList<java.lang.String,?> params)

Specified by:

invoke in interface ai.djl.ndarray.NDManager

invoke

public ai.djl.ndarray.NDList invoke(java.lang.String operation,
                                    ai.djl.ndarray.NDList src,
                                    ai.djl.util.PairList<java.lang.String,?> params)

Specified by:

invoke in interface ai.djl.ndarray.NDManager

invoke

public void invoke(java.lang.String operation,
                   ai.djl.ndarray.NDList src,
                   ai.djl.ndarray.NDList dest,
                   ai.djl.util.PairList<java.lang.String,?> params)

An engine specific generic invocation to native operator.

You should avoid using this function if possible. Since this function is engine specific, using this API may cause portability issues. A native operation may not be compatible between each version.

Parameters:

operation - the native operation to perform

src - the NDList of source NDArray

dest - the NDList to save output to

params - the parameters to be passed to the native operator

Throws:

java.lang.IllegalArgumentException - if operation is not supported by Engine

ai.djl.engine.EngineException - if operation failed in native engine

invoke

public ai.djl.ndarray.NDArray invoke(java.lang.String operation,
                                     ai.djl.ndarray.NDArray[] src,
                                     ai.djl.util.PairList<java.lang.String,?> params)

An engine specific generic invocation to native operator.

You should avoid using this function if possible. Since this function is engine specific, using this API may cause portability issues. A native operation may not be compatible between each version.

Parameters:

operation - the native operation to perform

src - the array of source NDArray

params - the parameters to be passed to the native operator

Returns:

the output array of NDArray

Throws:

java.lang.IllegalArgumentException - if operation is not supported by Engine

ai.djl.engine.EngineException - if operation failed in native engine

invoke

public ai.djl.ndarray.NDArray invoke(java.lang.String operation,
                                     ai.djl.ndarray.NDArray src,
                                     ai.djl.util.PairList<java.lang.String,?> params)

An engine specific generic invocation to native operator.

You should avoid using this function if possible. Since this function is engine specific, using this API may cause portability issues. A native operation may not be compatible between each version.

Parameters:

operation - the native operation to perform

src - the source NDArray

params - the parameters to be passed to the native operator

Returns:

the output array of NDArray

Throws:

java.lang.IllegalArgumentException - if operation is not supported by Engine

ai.djl.engine.EngineException - if operation failed in native engine

invoke

public ai.djl.ndarray.NDArray invoke(java.lang.String operation,
                                     ai.djl.util.PairList<java.lang.String,?> params)

An engine specific generic invocation to native operator.

You should avoid using this function if possible. Since this function is engine specific, using this API may cause portability issues. A native operation may not be compatible between each version.

Parameters:

operation - the native operation to perform

params - the parameters to be passed to the native operator

Returns:

the output array of NDArray

Throws:

java.lang.IllegalArgumentException - if operation is not supported by Engine

ai.djl.engine.EngineException - if operation failed in native engine

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public void close()

Specified by:

close in interface ai.djl.ndarray.NDManager

Specified by:

close in interface java.lang.AutoCloseable

debugDump

public void debugDump(int level)

Prints information about this NDManager and all sub-managers to the console.

Parameters:

level - the level of this NDManager in the hierarchy