ai.djl.mxnet.engine

Class MxModel

java.lang.Object

ai.djl.mxnet.engine.MxModel

All Implemented Interfaces:

ai.djl.Model, java.lang.AutoCloseable

public class MxModel
extends java.lang.Object
implements ai.djl.Model

MxModel is the MXNet implementation of Model.

MxModel contains all the methods in Model to load and process a model. In addition, it provides MXNet Specific functionality, such as getSymbol to obtain the Symbolic graph and getParameters to obtain the parameter NDArrays

Method Summary

Modifier and Type	Method and Description
void	cast(ai.djl.ndarray.types.DataType dataType)
void	close()
ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape>	describeInput()
ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape>	describeOutput()
protected void	finalize()
java.net.URL	getArtifact(java.lang.String artifactName)
<T> T	getArtifact(java.lang.String name, java.util.function.Function<java.io.InputStream,T> function)
java.io.InputStream	getArtifactAsStream(java.lang.String name)
java.lang.String[]	getArtifactNames()
ai.djl.nn.Block	getBlock()
ai.djl.ndarray.types.DataType	getDataType()
java.lang.String	getName()
ai.djl.ndarray.NDManager	getNDManager()
java.lang.String	getProperty(java.lang.String key)
void	load(java.nio.file.Path modelPath, java.lang.String modelName, java.util.Map<java.lang.String,java.lang.String> options) Loads the MXNet model from a specified location.
<I,O> ai.djl.inference.Predictor<I,O>	newPredictor(ai.djl.translate.Translator<I,O> translator)
ai.djl.training.Trainer	newTrainer(ai.djl.training.TrainingConfig trainingConfig)
void	save(java.nio.file.Path modelPath, java.lang.String modelName)
void	setBlock(ai.djl.nn.Block block)
void	setDataType(ai.djl.ndarray.types.DataType dataType)
void	setProperty(java.lang.String key, java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.Model

load, load, newInstance, newInstance, quantize

Method Detail

load

public void load(java.nio.file.Path modelPath,
                 java.lang.String modelName,
                 java.util.Map<java.lang.String,java.lang.String> options)
          throws java.io.IOException,
                 ai.djl.MalformedModelException

Loads the MXNet model from a specified location.

MXNet engine looks for {MODEL_NAME}-symbol.json and {MODEL_NAME}-{EPOCH}.params files in the specified directory. By default, MXNet engine will pick up the latest epoch of the parameter file. However, users can explicitly specify an epoch to be loaded:

 Map<String, String> options = new HashMap<>()
 options.put("epoch", "3");
 model.load(modelPath, "squeezenet", options);
 

Specified by:

load in interface ai.djl.Model

Parameters:

modelPath - the directory of the model

modelName - the name/prefix of the model

options - load model options, see documentation for the specific engine

Throws:

java.io.IOException - Exception for file loading

ai.djl.MalformedModelException

save

public void save(java.nio.file.Path modelPath,
                 java.lang.String modelName)
          throws java.io.IOException

Specified by:

save in interface ai.djl.Model

Throws:

java.io.IOException

getBlock

public ai.djl.nn.Block getBlock()

Specified by:

getBlock in interface ai.djl.Model

setBlock

public void setBlock(ai.djl.nn.Block block)

Specified by:

setBlock in interface ai.djl.Model

getName

public java.lang.String getName()

Specified by:

getName in interface ai.djl.Model

newTrainer

public ai.djl.training.Trainer newTrainer(ai.djl.training.TrainingConfig trainingConfig)

Specified by:

newTrainer in interface ai.djl.Model

newPredictor

public <I,O> ai.djl.inference.Predictor<I,O> newPredictor(ai.djl.translate.Translator<I,O> translator)

Specified by:

newPredictor in interface ai.djl.Model

setDataType

public void setDataType(ai.djl.ndarray.types.DataType dataType)

Specified by:

setDataType in interface ai.djl.Model

getDataType

public ai.djl.ndarray.types.DataType getDataType()

Specified by:

getDataType in interface ai.djl.Model

cast

public void cast(ai.djl.ndarray.types.DataType dataType)

Specified by:

cast in interface ai.djl.Model

describeInput

public ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape> describeInput()

Specified by:

describeInput in interface ai.djl.Model

describeOutput

public ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape> describeOutput()

Specified by:

describeOutput in interface ai.djl.Model

getArtifactNames

public java.lang.String[] getArtifactNames()

Specified by:

getArtifactNames in interface ai.djl.Model

getArtifact

public <T> T getArtifact(java.lang.String name,
                         java.util.function.Function<java.io.InputStream,T> function)
                  throws java.io.IOException

Specified by:

getArtifact in interface ai.djl.Model

Throws:

java.io.IOException

getArtifact

public java.net.URL getArtifact(java.lang.String artifactName)
                         throws java.io.IOException

Specified by:

getArtifact in interface ai.djl.Model

Throws:

java.io.IOException

getArtifactAsStream

public java.io.InputStream getArtifactAsStream(java.lang.String name)
                                        throws java.io.IOException

Specified by:

getArtifactAsStream in interface ai.djl.Model

Throws:

java.io.IOException

getNDManager

public ai.djl.ndarray.NDManager getNDManager()

Specified by:

getNDManager in interface ai.djl.Model

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Specified by:

setProperty in interface ai.djl.Model

getProperty

public java.lang.String getProperty(java.lang.String key)

Specified by:

getProperty in interface ai.djl.Model

close

public void close()

Specified by:

close in interface ai.djl.Model

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object