ai.djl.nn.convolutional

Class Convolution

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.ParameterBlock

ai.djl.nn.convolutional.Convolution

All Implemented Interfaces:

Block

Direct Known Subclasses:

Conv1D, Conv2D, Conv3D

public abstract class Convolution
extends ParameterBlock

Computes N-D convolution on (N+2)-D input.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Convolution.ConvolutionBuilder<T extends Convolution.ConvolutionBuilder> A builder that can build any Convolution block.

Field Summary

Fields

Modifier and Type	Field and Description
protected Parameter	bias
protected Shape	dilate
protected boolean	includeBias
protected Shape	kernel
protected int	numFilters
protected int	numGroups
protected Shape	pad
protected Shape	stride
protected Parameter	weight

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
Convolution(Convolution.ConvolutionBuilder<?> builder) Creates a Convolution object.

Method Summary

Modifier and Type	Method and Description
protected void	beforeInitialize(Shape[] inputs) Performs any action necessary before initialization.
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.
java.util.List<Parameter>	getDirectParameters() Returns a list of all the direct parameters of the block.
protected abstract LayoutType[]	getExpectedLayout() Returns the expected layout of the input.
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.
protected abstract java.lang.String	getStringLayout() Returns the string representing the layout of the input.
protected abstract byte	getVersion() Gets the version of the Convolution block.
void	loadParameters(NDManager manager, java.io.DataInputStream is) Loads the parameters from the given input stream.
protected abstract int	numDimensions() Returns the number of dimensions of the input.
void	saveParameters(java.io.DataOutputStream os) Writes the parameters of the block to the given outputStream.

Methods inherited from class ai.djl.nn.ParameterBlock

getChildren, initialize, toString

Methods inherited from class ai.djl.nn.AbstractBlock

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

Field Detail

kernel

protected Shape kernel

stride

protected Shape stride

pad

protected Shape pad

dilate

protected Shape dilate

numFilters

protected int numFilters

numGroups

protected int numGroups

includeBias

protected boolean includeBias

weight

protected Parameter weight

bias

protected Parameter bias

Constructor Detail

Convolution

public Convolution(Convolution.ConvolutionBuilder<?> builder)

Creates a Convolution object.

Parameters:

builder - the Builder that has the necessary configurations

Method Detail

getVersion

protected abstract byte getVersion()

Gets the version of the Convolution block.

Returns:

the version

getExpectedLayout

protected abstract LayoutType[] getExpectedLayout()

Returns the expected layout of the input.

Returns:

the expected layout of the input

getStringLayout

protected abstract java.lang.String getStringLayout()

Returns the string representing the layout of the input.

Returns:

the string representing the layout of the input

numDimensions

protected abstract int numDimensions()

Returns the number of dimensions of the input.

Returns:

the number of dimensions of the input

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

beforeInitialize

protected void beforeInitialize(Shape[] inputs)

Performs any action necessary before initialization.

Overrides:

beforeInitialize in class AbstractBlock

Parameters:

inputs - the expected shapes of the input

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

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

getDirectParameters

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

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

Returns:

the list of Parameter

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