ai.djl.modality.nlp.embedding

Class SimpleTextEmbedding

java.lang.Object

ai.djl.modality.nlp.embedding.SimpleTextEmbedding

All Implemented Interfaces:

TextEmbedding

public class SimpleTextEmbedding
extends java.lang.Object
implements TextEmbedding

A TextEmbedding that applies a WordEmbedding to each word independently.

Constructor Summary

Constructors

Constructor and Description
SimpleTextEmbedding(WordEmbedding 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).
int[]	preprocessTextToEmbed(java.util.List<java.lang.String> text) Preprocesses the text to embed into an array to pass into the model.
java.util.List<java.lang.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

Constructor Detail

SimpleTextEmbedding

public SimpleTextEmbedding(WordEmbedding 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)
                  throws EmbeddingException

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

Throws:

EmbeddingException - if there is an error while trying to embed

unembedText

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

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

Throws:

EmbeddingException - if the input is not unembeddable