ai.djl.modality.nlp.embedding

Class TrainableTextEmbedding

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.modality.nlp.embedding.TrainableTextEmbedding

All Implemented Interfaces:

TextEmbedding, Block

public class TrainableTextEmbedding
extends AbstractBlock
implements TextEmbedding

TrainableTextEmbedding is an implementation of TextEmbedding based on TrainableWordEmbedding block. This TextEmbedding is ideal when there are no pre-trained embeddings available, or when the pre-trained embedding needs to be further trained.

Field Summary

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
TrainableTextEmbedding(TrainableWordEmbedding wordEmbedding) Constructs a SimpleTextEmbedding.

Method Summary

Modifier and Type	Method and Description
NDArray	embedText(NDManager manager, int[] textIndices) Embeds the text after preprocessed using TextEmbedding.preprocessTextToEmbed(List).
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.
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[] 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.
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.
int[]	preprocessTextToEmbed(java.util.List<java.lang.String> text) Preprocesses the text to embed into an array to pass into the model.
void	saveParameters(java.io.DataOutputStream os) Writes the parameters of the block to the given outputStream.
java.util.List<java.lang.String>	unembedText(NDArray textEmbedding) Returns the closest matching text for a given embedding.

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, toString, wait, wait, wait

Methods inherited from interface ai.djl.modality.nlp.embedding.TextEmbedding

embedText

Methods inherited from interface ai.djl.nn.Block

forward, validateLayout

Constructor Detail

TrainableTextEmbedding

public TrainableTextEmbedding(TrainableWordEmbedding wordEmbedding)

Constructs a SimpleTextEmbedding.

Parameters:

wordEmbedding - the word embedding to embed each word

Method Detail

preprocessTextToEmbed

public int[] preprocessTextToEmbed(java.util.List<java.lang.String> text)

Preprocesses the text to embed into an array to pass into the model.

Make sure to call TextEmbedding.embedText(NDManager, int[]) after this.

Specified by:

preprocessTextToEmbed in interface TextEmbedding

Parameters:

text - the text to embed

Returns:

the indices of text that is ready to embed

embedText

public NDArray embedText(NDManager manager,
                         int[] textIndices)

Embeds the text after preprocessed using TextEmbedding.preprocessTextToEmbed(List).

Specified by:

embedText in interface TextEmbedding

Parameters:

manager - the manager to create the embedding array

textIndices - the text to embed

Returns:

the embedded text

unembedText

public java.util.List<java.lang.String> unembedText(NDArray textEmbedding)

Returns the closest matching text for a given embedding.

Specified by:

unembedText in interface TextEmbedding

Parameters:

textEmbedding - the text embedding to find the matching string text for.

Returns:

text similar to the passed in embedding

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

initialize

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

Description copied from interface: Block

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

Specified by:

initialize in interface Block

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

getChildren

public BlockList getChildren()

Description copied from interface: Block

Returns a list of all the children of the block.

Specified by:

getChildren in interface Block

Returns:

the list of child blocks

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