ai.djl.mxnet.engine

Class MxNDManager

java.lang.Object

ai.djl.ndarray.BaseNDManager

ai.djl.mxnet.engine.MxNDManager

All Implemented Interfaces:

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

public class MxNDManager
extends ai.djl.ndarray.BaseNDManager

MxNDManager is the MXNet implementation of NDManager.

Field Summary

Fields inherited from class ai.djl.ndarray.BaseNDManager

closed, device, name, parent, resources, uid

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	allocateDirect(int capacity)
ai.djl.ndarray.NDArray	arange(float start, float stop, float step, ai.djl.ndarray.types.DataType dataType)
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)
MxSparseNDArray	createCSR(java.nio.Buffer data, long[] indptr, long[] indices, ai.djl.ndarray.types.Shape shape)
MxSparseNDArray	createRowSparse(java.nio.Buffer data, ai.djl.ndarray.types.Shape dataShape, long[] indices, ai.djl.ndarray.types.Shape shape)
ai.djl.ndarray.NDArray	eye(int rows, int cols, int k, ai.djl.ndarray.types.DataType dataType)
ai.djl.ndarray.NDArray	full(ai.djl.ndarray.types.Shape shape, float value, ai.djl.ndarray.types.DataType dataType)
ai.djl.engine.Engine	getEngine()
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(float start, float stop, int num, boolean endpoint)
ai.djl.ndarray.NDList	load(java.nio.file.Path path)
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.ndarray.NDArray	randomInteger(long low, long high, ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType)
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(float loc, float scale, ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType)
ai.djl.ndarray.NDArray	randomUniform(float low, float high, ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType)
ai.djl.ndarray.NDArray	zeros(ai.djl.ndarray.types.Shape shape, ai.djl.ndarray.types.DataType dataType)

Methods inherited from class ai.djl.ndarray.BaseNDManager

attach, close, create, createCoo, debugDump, detach, getDevice, getName, getParentManager, isOpen, newSubManager, setName, toString

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, arange, arange, 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, create, createCSR, createRowSparse, decode, decode, eye, eye, eye, eye, full, full, full, linspace, linspace, linspace, linspace, load, newBaseManager, newBaseManager, newBaseManager, ones, ones, randomNormal, randomNormal, randomNormal, randomUniform, randomUniform, zeros, zeros

Method Detail

allocateDirect

public java.nio.ByteBuffer allocateDirect(int capacity)

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)

Specified by:

create in interface ai.djl.ndarray.NDManager

Overrides:

create in class ai.djl.ndarray.BaseNDManager

createCSR

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

Specified by:

createCSR in interface ai.djl.ndarray.NDManager

Overrides:

createCSR in class ai.djl.ndarray.BaseNDManager

createRowSparse

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

Specified by:

createRowSparse in interface ai.djl.ndarray.NDManager

Overrides:

createRowSparse in class ai.djl.ndarray.BaseNDManager

load

public ai.djl.ndarray.NDList load(java.nio.file.Path path)

Specified by:

load in interface ai.djl.ndarray.NDManager

Overrides:

load in class ai.djl.ndarray.BaseNDManager

zeros

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

Specified by:

zeros in interface ai.djl.ndarray.NDManager

Overrides:

zeros in class ai.djl.ndarray.BaseNDManager

ones

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

Specified by:

ones in interface ai.djl.ndarray.NDManager

Overrides:

ones in class ai.djl.ndarray.BaseNDManager

full

public ai.djl.ndarray.NDArray full(ai.djl.ndarray.types.Shape shape,
                                   float value,
                                   ai.djl.ndarray.types.DataType dataType)

Specified by:

full in interface ai.djl.ndarray.NDManager

Overrides:

full in class ai.djl.ndarray.BaseNDManager

arange

public ai.djl.ndarray.NDArray arange(float start,
                                     float stop,
                                     float step,
                                     ai.djl.ndarray.types.DataType dataType)

Specified by:

arange in interface ai.djl.ndarray.NDManager

Overrides:

arange in class ai.djl.ndarray.BaseNDManager

eye

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

Specified by:

eye in interface ai.djl.ndarray.NDManager

Overrides:

eye in class ai.djl.ndarray.BaseNDManager

linspace

public ai.djl.ndarray.NDArray linspace(float start,
                                       float stop,
                                       int num,
                                       boolean endpoint)

Specified by:

linspace in interface ai.djl.ndarray.NDManager

Overrides:

linspace in class ai.djl.ndarray.BaseNDManager

randomInteger

public ai.djl.ndarray.NDArray randomInteger(long low,
                                            long high,
                                            ai.djl.ndarray.types.Shape shape,
                                            ai.djl.ndarray.types.DataType dataType)

Specified by:

randomInteger in interface ai.djl.ndarray.NDManager

Overrides:

randomInteger in class ai.djl.ndarray.BaseNDManager

randomUniform

public ai.djl.ndarray.NDArray randomUniform(float low,
                                            float high,
                                            ai.djl.ndarray.types.Shape shape,
                                            ai.djl.ndarray.types.DataType dataType)

Specified by:

randomUniform in interface ai.djl.ndarray.NDManager

Overrides:

randomUniform in class ai.djl.ndarray.BaseNDManager

randomNormal

public ai.djl.ndarray.NDArray randomNormal(float loc,
                                           float scale,
                                           ai.djl.ndarray.types.Shape shape,
                                           ai.djl.ndarray.types.DataType dataType)

Specified by:

randomNormal in interface ai.djl.ndarray.NDManager

Overrides:

randomNormal in class ai.djl.ndarray.BaseNDManager

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

Overrides:

randomMultinomial in class ai.djl.ndarray.BaseNDManager

randomMultinomial

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

Specified by:

randomMultinomial in interface ai.djl.ndarray.NDManager

Overrides:

randomMultinomial in class ai.djl.ndarray.BaseNDManager

newSubManager

public MxNDManager newSubManager(ai.djl.Device dev)

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

Overrides:

invoke in class ai.djl.ndarray.BaseNDManager

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

Overrides:

invoke in class ai.djl.ndarray.BaseNDManager

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

getEngine

public final ai.djl.engine.Engine getEngine()