ai.djl.nn

Class AbstractBlock

java.lang.Object

ai.djl.nn.AbstractBlock

All Implemented Interfaces:

Block

Direct Known Subclasses:

Decoder, Encoder, EncoderDecoder, ParallelBlock, ParameterBlock, SequentialBlock, TrainableTextEmbedding, TransformerBaseBlock

public abstract class AbstractBlock
extends java.lang.Object
implements Block

AbstractBlock is an abstract implementation of Block. It is recommended that all Block classes that have children extend the AbstractBlock.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	inputNames
protected Shape[]	inputShapes

Constructor Summary

Constructors

Constructor and Description
AbstractBlock()

Method Summary

Modifier and Type	Method and Description
protected void	beforeInitialize(Shape[] inputShapes) Performs any action necessary before initialization.
void	cast(DataType dataType) Guaranteed to throw an exception.
void	clear() Closes all the parameters of the block.
ai.djl.util.PairList<java.lang.String,Shape>	describeInput() Returns a PairList of input names, and shapes.
ParameterList	getParameters() Returns a list of all the parameters of the block, including the parameters of its children fetched recursively.
boolean	isInitialized() Returns a boolean whether the block is initialized.
protected void	readInputShapes(java.io.DataInputStream is)
protected void	saveInputShapes(java.io.DataOutputStream os)
void	setInitializer(Initializer initializer) Sets an Initializer to the block.
void	setInitializer(Initializer initializer, java.lang.String paramName) Sets an Initializer to the specified direct parameter of the block, overriding the initializer of the parameter, if already set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.nn.Block

forward, forward, getChildren, getDirectParameters, getOutputShapes, getParameterShape, initialize, loadParameters, saveParameters, validateLayout

Field Detail

inputShapes

protected Shape[] inputShapes

inputNames

protected java.util.List<java.lang.String> inputNames

Constructor Detail

AbstractBlock

public AbstractBlock()

Method Detail

describeInput

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

Returns a PairList of input names, and shapes.

Specified by:

describeInput in interface Block

Returns:

the PairList of input names, and shapes

setInitializer

public void setInitializer(Initializer initializer)

Sets an Initializer to the block.

Specified by:

setInitializer in interface Block

Parameters:

initializer - the initializer to set

setInitializer

public void setInitializer(Initializer initializer,
                           java.lang.String paramName)

Sets an Initializer to the specified direct parameter of the block, overriding the initializer of the parameter, if already set.

Specified by:

setInitializer in interface Block

Parameters:

initializer - the initializer to be set

paramName - the name of the parameter

getParameters

public ParameterList getParameters()

Returns a list of all the parameters of the block, including the parameters of its children fetched recursively.

Specified by:

getParameters in interface Block

Returns:

the list of all parameters of the block

beforeInitialize

protected void beforeInitialize(Shape[] inputShapes)

Performs any action necessary before initialization.

Parameters:

inputShapes - the expected shapes of the input

isInitialized

public boolean isInitialized()

Returns a boolean whether the block is initialized.

Specified by:

isInitialized in interface Block

Returns:

whether the block is initialized

clear

public void clear()

Closes all the parameters of the block. All the updates made during training will be lost.

Specified by:

clear in interface Block

cast

public void cast(DataType dataType)

Guaranteed to throw an exception. Not yet implemented

Specified by:

cast in interface Block

Parameters:

dataType - the data type to cast to

saveInputShapes

protected void saveInputShapes(java.io.DataOutputStream os)
                        throws java.io.IOException

Throws:

java.io.IOException

readInputShapes

protected void readInputShapes(java.io.DataInputStream is)
                        throws java.io.IOException

Throws:

java.io.IOException