ai.djl.basicmodelzoo.nlp.embedding

Class ModelZooWordEmbedding

java.lang.Object

ai.djl.basicmodelzoo.nlp.embedding.ModelZooWordEmbedding

All Implemented Interfaces:

ai.djl.modality.nlp.WordEmbedding, java.lang.AutoCloseable

public class ModelZooWordEmbedding
extends java.lang.Object
implements ai.djl.modality.nlp.WordEmbedding, java.lang.AutoCloseable

A WordEmbedding using a ZooModel.

Constructor Summary

Constructors

Constructor and Description
ModelZooWordEmbedding(ai.djl.repository.zoo.ZooModel<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList> model) Constructs a ModelZooWordEmbedding.

Method Summary

Modifier and Type	Method and Description
void	close()
ai.djl.ndarray.NDArray	embedWord(ai.djl.ndarray.NDArray word)
ai.djl.ndarray.NDArray	preprocessWordToEmbed(ai.djl.ndarray.NDManager manager, java.lang.String word)
java.lang.String	unembedWord(ai.djl.ndarray.NDArray word)
boolean	vocabularyContains(java.lang.String word)

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.WordEmbedding

embedWord

Constructor Detail

ModelZooWordEmbedding

public ModelZooWordEmbedding(ai.djl.repository.zoo.ZooModel<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList> model)

Constructs a ModelZooWordEmbedding.

Parameters:

model - the model for the embedding. The model's block must consist of only an Embedding<String>.

Method Detail

vocabularyContains

public boolean vocabularyContains(java.lang.String word)

Specified by:

vocabularyContains in interface ai.djl.modality.nlp.WordEmbedding

preprocessWordToEmbed

public ai.djl.ndarray.NDArray preprocessWordToEmbed(ai.djl.ndarray.NDManager manager,
                                                    java.lang.String word)

Specified by:

preprocessWordToEmbed in interface ai.djl.modality.nlp.WordEmbedding

embedWord

public ai.djl.ndarray.NDArray embedWord(ai.djl.ndarray.NDArray word)
                                 throws ai.djl.modality.nlp.EmbeddingException

Specified by:

embedWord in interface ai.djl.modality.nlp.WordEmbedding

Throws:

ai.djl.modality.nlp.EmbeddingException

unembedWord

public java.lang.String unembedWord(ai.djl.ndarray.NDArray word)

Specified by:

unembedWord in interface ai.djl.modality.nlp.WordEmbedding

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable