ai.djl.mxnet.engine

Class MxSymbolBlock

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.ParameterBlock

ai.djl.mxnet.engine.MxSymbolBlock

All Implemented Interfaces:

ai.djl.nn.Block, ai.djl.nn.SymbolBlock

public class MxSymbolBlock
extends ai.djl.nn.ParameterBlock
implements ai.djl.nn.SymbolBlock

MxSymbolBlock is the MXNet implementation of SymbolBlock.

You can create a MxSymbolBlock using Model.load(java.nio.file.Path, String).

Field Summary

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
MxSymbolBlock(ai.djl.ndarray.NDManager manager, Symbol symbol) Constructs a MxSymbolBlock for a Symbol.

Method Summary

Modifier and Type	Method and Description
ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape>	describeInput()
ai.djl.ndarray.NDList	forward(ai.djl.training.ParameterStore parameterStore, ai.djl.ndarray.NDList inputs, boolean training, ai.djl.util.PairList<java.lang.String,java.lang.Object> params)
java.util.List<ai.djl.nn.Parameter>	getAllParameters() Returns the list of inputs and parameter NDArrays.
java.util.List<ai.djl.nn.Parameter>	getDirectParameters()
java.util.List<java.lang.String>	getLayerNames() Returns the layers' name.
ai.djl.ndarray.types.Shape[]	getOutputShapes(ai.djl.ndarray.NDManager manager, ai.djl.ndarray.types.Shape[] inputShapes)
ai.djl.ndarray.types.Shape	getParameterShape(java.lang.String name, ai.djl.ndarray.types.Shape[] inputShapes)
Symbol	getSymbol() Returns the Symbolic graph from the model.
ai.djl.ndarray.types.Shape[]	initialize(ai.djl.ndarray.NDManager manager, ai.djl.ndarray.types.DataType dataType, ai.djl.ndarray.types.Shape... inputShapes)
void	loadParameters(ai.djl.ndarray.NDManager manager, java.io.DataInputStream is)
void	removeLastBlock()
void	saveParameters(java.io.DataOutputStream os)
void	setInputNames(java.util.List<java.lang.String> inputNames) Sets the names of the input data.

Methods inherited from class ai.djl.nn.ParameterBlock

getChildren, toString

Methods inherited from class ai.djl.nn.AbstractBlock

beforeInitialize, cast, clear, getParameters, isInitialized, readInputShapes, saveInputShapes, setInitializer, setInitializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.nn.Block

cast, clear, forward, getChildren, getParameters, isInitialized, setInitializer, setInitializer, validateLayout

Constructor Detail

MxSymbolBlock

public MxSymbolBlock(ai.djl.ndarray.NDManager manager,
                     Symbol symbol)

Constructs a MxSymbolBlock for a Symbol.

You can create a MxSymbolBlock using Model.load(java.nio.file.Path, String).

Parameters:

manager - the manager to use for the block

symbol - the symbol containing the block's symbolic graph

Method Detail

setInputNames

public void setInputNames(java.util.List<java.lang.String> inputNames)

Sets the names of the input data.

Parameters:

inputNames - the names of the input data

getAllParameters

public java.util.List<ai.djl.nn.Parameter> getAllParameters()

Returns the list of inputs and parameter NDArrays.

Returns:

the list of inputs and parameter NDArrays

initialize

public ai.djl.ndarray.types.Shape[] initialize(ai.djl.ndarray.NDManager manager,
                                               ai.djl.ndarray.types.DataType dataType,
                                               ai.djl.ndarray.types.Shape... inputShapes)

Specified by:

initialize in interface ai.djl.nn.Block

Overrides:

initialize in class ai.djl.nn.ParameterBlock

getLayerNames

public java.util.List<java.lang.String> getLayerNames()

Returns the layers' name.

Returns:

a List of String containing the layers' name

getSymbol

public Symbol getSymbol()

Returns the Symbolic graph from the model.

Returns:

a Symbol object

describeInput

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

Specified by:

describeInput in interface ai.djl.nn.Block

Overrides:

describeInput in class ai.djl.nn.AbstractBlock

forward

public ai.djl.ndarray.NDList forward(ai.djl.training.ParameterStore parameterStore,
                                     ai.djl.ndarray.NDList inputs,
                                     boolean training,
                                     ai.djl.util.PairList<java.lang.String,java.lang.Object> params)

Specified by:

forward in interface ai.djl.nn.Block

getOutputShapes

public ai.djl.ndarray.types.Shape[] getOutputShapes(ai.djl.ndarray.NDManager manager,
                                                    ai.djl.ndarray.types.Shape[] inputShapes)

Specified by:

getOutputShapes in interface ai.djl.nn.Block

getDirectParameters

public java.util.List<ai.djl.nn.Parameter> getDirectParameters()

Specified by:

getDirectParameters in interface ai.djl.nn.Block

removeLastBlock

public void removeLastBlock()

Specified by:

removeLastBlock in interface ai.djl.nn.SymbolBlock

getParameterShape

public ai.djl.ndarray.types.Shape getParameterShape(java.lang.String name,
                                                    ai.djl.ndarray.types.Shape[] inputShapes)

Specified by:

getParameterShape in interface ai.djl.nn.Block

saveParameters

public void saveParameters(java.io.DataOutputStream os)
                    throws java.io.IOException

Specified by:

saveParameters in interface ai.djl.nn.Block

Throws:

java.io.IOException

loadParameters

public void loadParameters(ai.djl.ndarray.NDManager manager,
                           java.io.DataInputStream is)
                    throws java.io.IOException,
                           ai.djl.MalformedModelException

Specified by:

loadParameters in interface ai.djl.nn.Block

Throws:

java.io.IOException

ai.djl.MalformedModelException