ai.djl.mxnet.engine

Class Symbol

java.lang.Object

ai.djl.mxnet.jna.NativeResource

ai.djl.mxnet.engine.Symbol

All Implemented Interfaces:

java.lang.AutoCloseable

public class Symbol
extends NativeResource

Symbol is an internal helper for symbolic model graphs used by the SymbolBlock.

See Also:

SymbolBlock, MXNet Symbol

Field Summary

Fields inherited from class ai.djl.mxnet.jna.NativeResource

handle

Method Summary

Modifier and Type	Method and Description
void	close()
Symbol	copy() Copies the symbol.
Symbol	get(int index) Returns the output symbol by index.
Symbol	get(java.lang.String name) Returns the output symbol with the given name.
java.lang.String[]	getAllNames() Returns the symbol names.
java.lang.String[]	getArgNames() Returns the symbol argument names.
java.lang.String[]	getAuxNames() Returns the MXNet auxiliary states for the symbol.
Symbol	getInternals() Returns the symbol internals.
java.util.List<java.lang.String>	getLayerNames() Returns the list of names for all internal outputs.
java.lang.String[]	getOutputNames() Returns the symbol outputs.
java.util.Map<java.lang.String,ai.djl.ndarray.types.Shape>	inferShape(ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape> pairs) Infers the shapes for all parameters inside a symbol from the given input shapes.
static Symbol	load(MxNDManager manager, java.lang.String path) Loads a symbol from a path.
java.lang.String	toString()

Methods inherited from class ai.djl.mxnet.jna.NativeResource

finalize, getHandle, getUid, isReleased

Methods inherited from class java.lang.Object

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

Method Detail

load

public static Symbol load(MxNDManager manager,
                          java.lang.String path)

Loads a symbol from a path.

Parameters:

manager - the manager to load the symbol to

path - the path to the symbol file

Returns:

the new symbol

getArgNames

public java.lang.String[] getArgNames()

Returns the symbol argument names.

Returns:

the symbol argument names

getAuxNames

public java.lang.String[] getAuxNames()

Returns the MXNet auxiliary states for the symbol.

Returns:

the MXNet auxiliary states for the symbol

getAllNames

public java.lang.String[] getAllNames()

Returns the symbol names.

Returns:

the symbol names

getOutputNames

public java.lang.String[] getOutputNames()

Returns the symbol outputs.

Returns:

the symbol outputs

copy

public Symbol copy()

Copies the symbol.

Returns:

a new copy of the symbol

get

public Symbol get(int index)

Returns the output symbol by index.

Parameters:

index - the index of the output

Returns:

the symbol output as a new symbol

get

public Symbol get(java.lang.String name)

Returns the output symbol with the given name.

Parameters:

name - the name of the symbol to return

Returns:

the output symbol

Throws:

java.lang.IllegalArgumentException - Thrown if no output matches the name

getInternals

public Symbol getInternals()

Returns the symbol internals.

Returns:

the symbol internals symbol

getLayerNames

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

Returns the list of names for all internal outputs.

Returns:

a list of names

inferShape

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

Infers the shapes for all parameters inside a symbol from the given input shapes.

Parameters:

pairs - the given input name and shape

Returns:

a map of arguments with names and shapes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class NativeResource