Package ai.djl.nn
Class SequentialBlock
- java.lang.Object
-
- ai.djl.nn.AbstractBaseBlock
-
- ai.djl.nn.AbstractBlock
-
- ai.djl.nn.SequentialBlock
-
- All Implemented Interfaces:
Block
- Direct Known Subclasses:
PointwiseFeedForwardBlock
public class SequentialBlock extends AbstractBlock
SequentialBlock
is aBlock
whose children form a chain of blocks with each child block feeding its output to the next. The output of the last child is returned as the output of theSequentialBlock
.SequentialBlock
has no direct parameters.
-
-
Field Summary
-
Fields inherited from class ai.djl.nn.AbstractBlock
children, parameters
-
Fields inherited from class ai.djl.nn.AbstractBaseBlock
inputNames, inputShapes, version
-
-
Constructor Summary
Constructors Constructor Description SequentialBlock()
Creates an empty sequential block.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SequentialBlock
add(Block block)
Adds the givenBlock
to the block to be executed in order.SequentialBlock
add(java.util.function.Function<NDList,NDList> f)
Adds aLambdaBlock
that applies the given function to the sequence of blocks.SequentialBlock
add(java.util.function.Function<NDList,NDList> f, java.lang.String name)
Adds aLambdaBlock
that applies the given function to the sequence of blocks.SequentialBlock
addAll(Block... blocks)
Adds an array of blocks to be executed in sequence, in order.SequentialBlock
addAll(java.util.Collection<Block> blocks)
Adds aCollection
of blocks to be executed in sequence, in order.SequentialBlock
addSingleton(java.util.function.Function<NDArray,NDArray> f)
Adds aLambdaBlock.singleton(Function)
that applies the given function to the sequence of blocks.SequentialBlock
addSingleton(java.util.function.Function<NDArray,NDArray> f, java.lang.String name)
Adds aLambdaBlock.singleton(Function)
that applies the given function to the sequence of blocks.protected NDList
forwardInternal(ParameterStore parameterStore, NDList inputs, boolean training, ai.djl.util.PairList<java.lang.String,java.lang.Object> params)
A helper forBlock.forward(ParameterStore, NDList, boolean, PairList)
after initialization.protected NDList
forwardInternal(ParameterStore parameterStore, NDList data, NDList labels, ai.djl.util.PairList<java.lang.String,java.lang.Object> params)
A helper forBlock.forward(ParameterStore, NDList, NDList, PairList)
after initialization.Shape[]
getOutputShapes(Shape[] inputs)
Returns the expected output shapes of the block for the specified input shapes.void
initializeChildBlocks(NDManager manager, DataType dataType, Shape... inputShapes)
Initializes the Child blocks of this block.boolean
isReturnIntermediate()
Returns whether the block returns all intermediate block results or only the end of the sequential chain.void
loadMetadata(byte loadVersion, java.io.DataInputStream is)
Overwrite this to load additional metadata with the parameter values.void
removeLastBlock()
Removes theBlock
added last from the sequence of blocks.void
replaceLastBlock(Block block)
Replaces theBlock
last added from the sequence of blocks, and adds the given block.protected void
saveMetadata(java.io.DataOutputStream os)
Override this method to save additional data apart from parameter values.SequentialBlock
setReturnIntermediate(boolean returnIntermediate)
Sets whether the block returns all intermediate sequence results.-
Methods inherited from class ai.djl.nn.AbstractBlock
addChildBlock, addChildBlock, addChildBlockSingleton, addParameter, getChildren, getDirectParameters
-
Methods inherited from class ai.djl.nn.AbstractBaseBlock
beforeInitialize, cast, clear, describeInput, forward, forward, getInputShapes, getParameters, initialize, isInitialized, loadParameters, prepare, readInputShapes, saveInputShapes, saveParameters, setInitializer, setInitializer, setInitializer, toString
-
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
forward, freezeParameters
-
-
-
-
Method Detail
-
addAll
public SequentialBlock addAll(Block... blocks)
Adds an array of blocks to be executed in sequence, in order.- Parameters:
blocks
- the array of blocks- Returns:
- this block
-
addAll
public SequentialBlock addAll(java.util.Collection<Block> blocks)
Adds aCollection
of blocks to be executed in sequence, in order.- Parameters:
blocks
- theCollection
of blocks- Returns:
- this block
-
add
public SequentialBlock add(Block block)
Adds the givenBlock
to the block to be executed in order.- Parameters:
block
- the block to be added to the sequence of blocks- Returns:
- this block
-
add
public SequentialBlock add(java.util.function.Function<NDList,NDList> f)
Adds aLambdaBlock
that applies the given function to the sequence of blocks.- Parameters:
f
- the function forms theLambdaBlock
- Returns:
- this block
-
add
public SequentialBlock add(java.util.function.Function<NDList,NDList> f, java.lang.String name)
Adds aLambdaBlock
that applies the given function to the sequence of blocks.- Parameters:
f
- the function forms theLambdaBlock
name
- the function name- Returns:
- this block
-
addSingleton
public SequentialBlock addSingleton(java.util.function.Function<NDArray,NDArray> f)
Adds aLambdaBlock.singleton(Function)
that applies the given function to the sequence of blocks.- Parameters:
f
- the function forms theLambdaBlock
- Returns:
- this block
- See Also:
LambdaBlock.singleton(Function)
-
addSingleton
public SequentialBlock addSingleton(java.util.function.Function<NDArray,NDArray> f, java.lang.String name)
Adds aLambdaBlock.singleton(Function)
that applies the given function to the sequence of blocks.- Parameters:
f
- the function forms theLambdaBlock
name
- the function name- Returns:
- this block
- See Also:
LambdaBlock.singleton(Function)
-
removeLastBlock
public void removeLastBlock()
Removes theBlock
added last from the sequence of blocks.
-
replaceLastBlock
public void replaceLastBlock(Block block)
Replaces theBlock
last added from the sequence of blocks, and adds the given block.- Parameters:
block
- the block to replace the last block with
-
isReturnIntermediate
public boolean isReturnIntermediate()
Returns whether the block returns all intermediate block results or only the end of the sequential chain.- Returns:
- whether the block returns all intermediate block results or only the end of the sequential chain
-
setReturnIntermediate
public SequentialBlock setReturnIntermediate(boolean returnIntermediate)
Sets whether the block returns all intermediate sequence results.- Parameters:
returnIntermediate
- true for intermediates, false for only chain result (default and typical behavior is false)- Returns:
- this
SequentialBlock
-
forwardInternal
protected NDList forwardInternal(ParameterStore parameterStore, NDList inputs, boolean training, ai.djl.util.PairList<java.lang.String,java.lang.Object> params)
A helper forBlock.forward(ParameterStore, NDList, boolean, PairList)
after initialization.- Specified by:
forwardInternal
in classAbstractBaseBlock
- Parameters:
parameterStore
- the parameter storeinputs
- the input NDListtraining
- true for a training forward passparams
- optional parameters- Returns:
- the output of the forward pass
-
forwardInternal
protected NDList forwardInternal(ParameterStore parameterStore, NDList data, NDList labels, ai.djl.util.PairList<java.lang.String,java.lang.Object> params)
A helper forBlock.forward(ParameterStore, NDList, NDList, PairList)
after initialization.- Overrides:
forwardInternal
in classAbstractBaseBlock
- Parameters:
parameterStore
- the parameter storedata
- the input data NDListlabels
- the input labels NDListparams
- optional parameters- Returns:
- the output of the forward pass
- See Also:
AbstractBaseBlock.forward(ParameterStore, NDList, boolean, PairList)
-
initializeChildBlocks
public void initializeChildBlocks(NDManager manager, DataType dataType, Shape... inputShapes)
Initializes the Child blocks of this block. You need to override this method if your subclass has child blocks. Used to determine the correct input shapes for child blocks based on the requested input shape for this block.- Overrides:
initializeChildBlocks
in classAbstractBaseBlock
- Parameters:
manager
- the manager to use for initializationdataType
- the requested data typeinputShapes
- the expected input shapes for this block
-
getOutputShapes
public Shape[] getOutputShapes(Shape[] inputs)
Returns the expected output shapes of the block for the specified input shapes.- Parameters:
inputs
- the shapes of the inputs- Returns:
- the expected output shapes of the block
-
saveMetadata
protected void saveMetadata(java.io.DataOutputStream os) throws java.io.IOException
Override this method to save additional data apart from parameter values.This default implementation saves the currently set input shapes.
- Overrides:
saveMetadata
in classAbstractBaseBlock
- Parameters:
os
- the non-null output stream the parameter values and metadata are written to- Throws:
java.io.IOException
- saving failed
-
loadMetadata
public void loadMetadata(byte loadVersion, java.io.DataInputStream is) throws java.io.IOException, MalformedModelException
Overwrite this to load additional metadata with the parameter values.If you overwrite
AbstractBaseBlock.saveMetadata(DataOutputStream)
or need to provide backward compatibility to older binary formats, you prabably need to overwrite this. This default implementation checks if the version number fits, if not it throws anMalformedModelException
. After that it restores the input shapes.- Overrides:
loadMetadata
in classAbstractBaseBlock
- Parameters:
loadVersion
- the version used for loading this metadata.is
- the input stream we are loading from- Throws:
java.io.IOException
- loading failedMalformedModelException
- data can be loaded but has wrong format
-
-