ai.djl.nn

Class SequentialBlock

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.SequentialBlock

All Implemented Interfaces:

Block

public class SequentialBlock
extends AbstractBlock

SequentialBlock is a Block 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 the SequentialBlock.

SequentialBlock has no direct parameters.

Field Summary

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
SequentialBlock()

Method Summary

Modifier and Type	Method and Description
SequentialBlock	add(Block block) Adds the given Block to the block to be executed in order.
SequentialBlock	add(java.util.function.Function<NDList,NDList> f) Adds a LambdaBlock 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 a Collection of blocks to be executed in sequence, in order.
NDList	forward(ParameterStore parameterStore, NDList inputs, ai.djl.util.PairList<java.lang.String,java.lang.Object> params) Applies the operating function of the block once.
BlockList	getChildren() Returns a list of all the children of the block.
java.util.List<Parameter>	getDirectParameters() Returns a list of all the direct parameters of the block.
Shape[]	getOutputShapes(NDManager manager, Shape[] inputs) Returns the expected output shapes of the block for the specified input shapes.
Shape	getParameterShape(java.lang.String name, Shape[] inputShapes) Returns the shape of the specified direct parameter of this block given the shapes of the input to the block.
Shape[]	initialize(NDManager manager, DataType dataType, Shape... inputShapes) Initializes the parameters of the block.
void	loadParameters(NDManager manager, java.io.DataInputStream is) Loads the parameters from the given input stream.
void	removeLastBlock() Removes the Block added last from the sequence of blocks.
void	replaceLastBlock(Block block) Replaces the Block last added from the sequence of blocks, and adds the given block.
void	saveParameters(java.io.DataOutputStream os) Writes the parameters of the block to the given outputStream.
java.lang.String	toString()

Methods inherited from class ai.djl.nn.AbstractBlock

beforeInitialize, cast, clear, describeInput, getParameters, isInitialized, 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

forward, validateLayout

Constructor Detail

SequentialBlock

public SequentialBlock()

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 a Collection of blocks to be executed in sequence, in order.

Parameters:

blocks - the Collection of blocks

Returns:

this block

add

public SequentialBlock add(Block block)

Adds the given Block 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 a LambdaBlock that applies the given function to the sequence of blocks.

Parameters:

f - the function forms the LambdaBlock

Returns:

this block

removeLastBlock

public void removeLastBlock()

Removes the Block added last from the sequence of blocks.

replaceLastBlock

public void replaceLastBlock(Block block)

Replaces the Block last added from the sequence of blocks, and adds the given block.

Parameters:

block - the block to replace the last block with

forward

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

Applies the operating function of the block once. This method should be called only on blocks that are initialized.

Parameters:

parameterStore - the parameter store

inputs - the input NDList

params - optional parameters

Returns:

the output of the forward pass

initialize

public Shape[] initialize(NDManager manager,
                          DataType dataType,
                          Shape... inputShapes)

Initializes the parameters of the block. This method must be called before calling `forward`.

Parameters:

manager - the NDManager to initialize the parameters

dataType - the datatype of the parameters

inputShapes - the shapes of the inputs to the block

Returns:

the shapes of the outputs of the block

getOutputShapes

public Shape[] getOutputShapes(NDManager manager,
                               Shape[] inputs)

Returns the expected output shapes of the block for the specified input shapes.

Parameters:

manager - an NDManager

inputs - the shapes of the inputs

Returns:

the expected output shapes of the block

getDirectParameters

public java.util.List<Parameter> getDirectParameters()

Returns a list of all the direct parameters of the block.

Returns:

the list of Parameter

getParameterShape

public Shape getParameterShape(java.lang.String name,
                               Shape[] inputShapes)

Returns the shape of the specified direct parameter of this block given the shapes of the input to the block.

Parameters:

name - the name of the parameter

inputShapes - the shapes of the input to the block

Returns:

the shape of the parameter specified

getChildren

public BlockList getChildren()

Returns a list of all the children of the block.

Returns:

the list of child blocks

saveParameters

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

Writes the parameters of the block to the given outputStream.

Parameters:

os - the outputstream to save the parameters to

Throws:

java.io.IOException - if an I/O error occurs

loadParameters

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

Loads the parameters from the given input stream.

Parameters:

manager - an NDManager to create the parameter arrays

is - the inputstream that stream the parameter values

Throws:

java.io.IOException - if an I/O error occurs

MalformedModelException - if the model file is corrupted or unsupported

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object