ai.djl.nn.core

Class ConstantEmbedding

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.ParameterBlock

ai.djl.nn.core.ConstantEmbedding

All Implemented Interfaces:

Block, AbstractEmbedding, AbstractIndexedEmbedding

public class ConstantEmbedding
extends ParameterBlock
implements AbstractIndexedEmbedding

An AbstractIndexedEmbedding that always returns a constant value.

Field Summary

Fields

Modifier and Type	Field and Description
protected NDArray	embedding

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
ConstantEmbedding(NDArray embedding) Constructs a constant embedding with the given constant.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	decode(byte[] byteArray) Decodes the given byte array into an object of input parameter type.
NDArray	embed(NDManager manager, java.lang.Object[] items) Embeds an array of items.
int	embed(java.lang.Object item) Embeds an item.
byte[]	encode(java.lang.Object input) Encodes an object of input type into a byte array.
NDList	forward(ParameterStore parameterStore, NDList inputs, boolean training, 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.
Shape[]	getOutputShapes(NDManager manager, Shape[] inputShapes) 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.
boolean	hasItem(java.lang.Object item) Returns whether an item is in the embedding.
void	loadParameters(NDManager manager, java.io.DataInputStream is) Loads the parameters from the given input stream.
void	saveParameters(java.io.DataOutputStream os) Writes the parameters of the block to the given outputStream.
java.util.Optional<?>	unembed(int index) Returns the item corresponding to the given index.

Methods inherited from class ai.djl.nn.ParameterBlock

getChildren, initialize, toString

Methods inherited from class ai.djl.nn.AbstractBlock

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

embedding

protected NDArray embedding

Constructor Detail

ConstantEmbedding

public ConstantEmbedding(NDArray embedding)

Constructs a constant embedding with the given constant.

Parameters:

embedding - the value to return for all embeddings

Method Detail

forward

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

Description copied from interface: Block

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

Specified by:

forward in interface Block

Parameters:

parameterStore - the parameter store

inputs - the input NDList

training - true for a training forward pass

params - optional parameters

Returns:

the output of the forward pass

getDirectParameters

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

Description copied from interface: Block

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

Specified by:

getDirectParameters in interface Block

Returns:

the list of Parameter

getParameterShape

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

Description copied from interface: Block

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

Specified by:

getParameterShape in interface Block

Parameters:

name - the name of the parameter

inputShapes - the shapes of the input to the block

Returns:

the shape of the parameter specified

getOutputShapes

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

Description copied from interface: Block

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

Specified by:

getOutputShapes in interface Block

Parameters:

manager - an NDManager

inputShapes - the shapes of the inputs

Returns:

the expected output shapes of the block

saveParameters

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

Description copied from interface: Block

Writes the parameters of the block to the given outputStream.

Specified by:

saveParameters in interface Block

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

Description copied from interface: Block

Loads the parameters from the given input stream.

Specified by:

loadParameters in interface Block

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

unembed

public java.util.Optional<?> unembed(int index)

Description copied from interface: AbstractIndexedEmbedding

Returns the item corresponding to the given index.

Specified by:

unembed in interface AbstractIndexedEmbedding

Parameters:

index - the index

Returns:

the item corresponding to the given index

encode

public byte[] encode(java.lang.Object input)
              throws java.io.IOException

Description copied from interface: AbstractIndexedEmbedding

Encodes an object of input type into a byte array. This is used in saving and loading the Embedding objects.

Specified by:

encode in interface AbstractIndexedEmbedding

Parameters:

input - the input object to be encoded

Returns:

the encoded byte array.

Throws:

java.io.IOException - if there is an error while encoding

decode

public java.lang.Object decode(byte[] byteArray)
                        throws java.io.IOException

Description copied from interface: AbstractIndexedEmbedding

Decodes the given byte array into an object of input parameter type.

Specified by:

decode in interface AbstractIndexedEmbedding

Parameters:

byteArray - the byte array to be decoded

Returns:

the decode object of input parameter type

Throws:

java.io.IOException - if there was an error while decoding

embed

public int embed(java.lang.Object item)

Description copied from interface: AbstractIndexedEmbedding

Embeds an item.

Specified by:

embed in interface AbstractIndexedEmbedding

Parameters:

item - the item to embed

Returns:

the embedding NDArray of Shape()

embed

public NDArray embed(NDManager manager,
                     java.lang.Object[] items)

Description copied from interface: AbstractEmbedding

Embeds an array of items.

Specified by:

embed in interface AbstractEmbedding

Parameters:

manager - the manager for the new embeddings

items - the items to embed

Returns:

the embedding NDArray of Shape(items.length, embeddingSize)

hasItem

public boolean hasItem(java.lang.Object item)

Description copied from interface: AbstractEmbedding

Returns whether an item is in the embedding.

Specified by:

hasItem in interface AbstractEmbedding

Parameters:

item - the item to test

Returns:

true if the item is in the embedding