Package ai.djl.modality.nlp.embedding

Class SimpleTextEmbedding

java.lang.Object

ai.djl.modality.nlp.embedding.SimpleTextEmbedding

All Implemented Interfaces:

TextEmbedding

public class SimpleTextEmbedding
extends Object
implements TextEmbedding

A TextEmbedding that applies a WordEmbedding to each word independently.

Constructor Summary

Constructors

Constructor	Description
SimpleTextEmbedding(WordEmbedding wordEmbedding)	Constructs a SimpleTextEmbedding.

Method Summary

Modifier and Type	Method	Description
NDArray	embedText(NDArray textIndices)	Embeds the text after preprocessed using TextEmbedding.preprocessTextToEmbed(List).
long[]	preprocessTextToEmbed(List<String> text)	Preprocesses the text to embed into an array to pass into the model.
List<String>	unembedText(NDArray textEmbedding)	Returns the closest matching text for a given embedding.

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, embedText

Constructor Details

SimpleTextEmbedding

public SimpleTextEmbedding(WordEmbedding wordEmbedding)

Constructs a SimpleTextEmbedding.

Parameters:

wordEmbedding - the word embedding to embed each word

Method Details

preprocessTextToEmbed

public long[] preprocessTextToEmbed(List<String> text)

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

Make sure to call TextEmbedding.embedText(NDManager, long[]) 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(NDArray textIndices)
                  throws EmbeddingException

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

Specified by:

embedText in interface TextEmbedding

Parameters:

textIndices - the indices of text to embed

Returns:

the embedded text

Throws:

EmbeddingException - if there is an error while trying to embed

unembedText

public List<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