Uses of Class
org.deeplearning4j.models.word2vec.VocabWord

Packages that use VocabWord

Package	Description
org.deeplearning4j.bagofwords.vectorizer
org.deeplearning4j.models.embeddings.loader
org.deeplearning4j.models.paragraphvectors
org.deeplearning4j.models.sequencevectors.serialization
org.deeplearning4j.models.sequencevectors.transformers.impl
org.deeplearning4j.models.sequencevectors.transformers.impl.iterables
org.deeplearning4j.models.word2vec
org.deeplearning4j.models.word2vec.wordstore.inmemory

Uses of VocabWord in org.deeplearning4j.bagofwords.vectorizer

Fields in org.deeplearning4j.bagofwords.vectorizer with type parameters of type VocabWord

Modifier and Type	Field	Description
protected InvertedIndex<VocabWord>	BaseTextVectorizer.index
protected VocabCache<VocabWord>	BagOfWordsVectorizer.Builder.vocabCache
protected VocabCache<VocabWord>	BaseTextVectorizer.vocabCache
protected VocabCache<VocabWord>	TfidfVectorizer.Builder.vocabCache

Methods in org.deeplearning4j.bagofwords.vectorizer that return types with arguments of type VocabWord

Modifier and Type	Method	Description
InvertedIndex<VocabWord>	TextVectorizer.getIndex()	Inverted index
VocabCache<VocabWord>	TextVectorizer.getVocabCache()	The vocab sorted in descending order

Method parameters in org.deeplearning4j.bagofwords.vectorizer with type arguments of type VocabWord

Modifier and Type	Method	Description
BagOfWordsVectorizer.Builder	BagOfWordsVectorizer.Builder.setVocab(@NonNull VocabCache<VocabWord> vocab)
TfidfVectorizer.Builder	TfidfVectorizer.Builder.setVocab(@NonNull VocabCache<VocabWord> vocab)

Uses of VocabWord in org.deeplearning4j.models.embeddings.loader

Methods in org.deeplearning4j.models.embeddings.loader that return types with arguments of type VocabWord

Modifier and Type	Method	Description
org.nd4j.common.primitives.Pair<VocabWord,float[]>	WordVectorSerializer.BinaryReader.next()
org.nd4j.common.primitives.Pair<VocabWord,float[]>	WordVectorSerializer.CSVReader.next()
org.nd4j.common.primitives.Pair<VocabWord,float[]>	WordVectorSerializer.Reader.next()
static VocabCache<VocabWord>	WordVectorSerializer.readVocabCache(@NonNull File file)	This method reads vocab cache from provided file.
static VocabCache<VocabWord>	WordVectorSerializer.readVocabCache(@NonNull InputStream stream)	This method reads vocab cache from provided InputStream.

Method parameters in org.deeplearning4j.models.embeddings.loader with type arguments of type VocabWord

Modifier and Type	Method	Description
static void	WordVectorSerializer.writeVocabCache(@NonNull VocabCache<VocabWord> vocabCache, @NonNull File file)	This method saves vocab cache to provided File.
static void	WordVectorSerializer.writeVocabCache(@NonNull VocabCache<VocabWord> vocabCache, @NonNull OutputStream stream)	This method saves vocab cache to provided OutputStream.

Uses of VocabWord in org.deeplearning4j.models.paragraphvectors

Fields in org.deeplearning4j.models.paragraphvectors with type parameters of type VocabWord

Modifier and Type	Field	Description
protected List<VocabWord>	ParagraphVectors.labelsList

Methods in org.deeplearning4j.models.paragraphvectors with parameters of type VocabWord

Modifier and Type	Method	Description
ParagraphVectors.Builder	ParagraphVectors.Builder.unknownElement(VocabWord element)	This method allows you to specify SequenceElement that will be used as UNK element, if UNK is used

Method parameters in org.deeplearning4j.models.paragraphvectors with type arguments of type VocabWord

Modifier and Type	Method	Description
ParagraphVectors.Builder	ParagraphVectors.Builder.elementsLearningAlgorithm(ElementsLearningAlgorithm<VocabWord> algorithm)
org.nd4j.linalg.api.ndarray.INDArray	ParagraphVectors.inferVector(@NonNull List<VocabWord> document)	This method calculates inferred vector for given list of words, with default parameters for learning rate and iterations
org.nd4j.linalg.api.ndarray.INDArray	ParagraphVectors.inferVector(@NonNull List<VocabWord> document, double learningRate, double minLearningRate, int iterations)	This method calculates inferred vector for given document
ParagraphVectors.Builder	ParagraphVectors.Builder.iterate(@NonNull SequenceIterator<VocabWord> iterator)	This method used to feed SequenceIterator, that contains training corpus, into ParagraphVectors
ParagraphVectors.Builder	ParagraphVectors.Builder.lookupTable(@NonNull WeightLookupTable<VocabWord> lookupTable)	This method allows to define external WeightLookupTable to be used
ParagraphVectors.Builder	ParagraphVectors.Builder.modelUtils(@NonNull ModelUtils<VocabWord> modelUtils)	Sets ModelUtils that gonna be used as provider for utility methods: similarity(), wordsNearest(), accuracy(), etc
Collection<String>	ParagraphVectors.nearestLabels(@NonNull Collection<VocabWord> document, int topN)	This method returns top N labels nearest to specified set of vocab words
String	ParagraphVectors.predict(List<VocabWord> document)	This method predicts label of the document.
Collection<String>	ParagraphVectors.predictSeveral(List<VocabWord> document, int limit)	Predict several labels based on the document.
ParagraphVectors.Builder	ParagraphVectors.Builder.sequenceLearningAlgorithm(SequenceLearningAlgorithm<VocabWord> algorithm)
void	ParagraphVectors.setSequenceIterator(@NonNull SequenceIterator<VocabWord> iterator)	This method defines SequenceIterator instance, that will be used as training corpus source.
ParagraphVectors.Builder	ParagraphVectors.Builder.setVectorsListeners(@NonNull Collection<VectorsListener<VocabWord>> vectorsListeners)	This method sets VectorsListeners for this SequenceVectors model
double	ParagraphVectors.similarityToLabel(List<VocabWord> document, String label)	This method returns similarity of the document to specific label, based on mean value
ParagraphVectors.Builder	ParagraphVectors.Builder.stopWords(@NonNull Collection<VocabWord> stopList)	This method defines stop words that should be ignored during training
ParagraphVectors.Builder	ParagraphVectors.Builder.vocabCache(@NonNull VocabCache<VocabWord> vocabCache)	This method allows to define external VocabCache to be used

Constructor parameters in org.deeplearning4j.models.paragraphvectors with type arguments of type VocabWord

Constructor	Description
BlindInferenceCallable(@NonNull VocabCache<VocabWord> vocabCache, @NonNull TokenizerFactory tokenizerFactory, @NonNull String document)
BlindInferenceCallable(@NonNull VocabCache<VocabWord> vocabCache, @NonNull TokenizerFactory tokenizerFactory, @NonNull String document, @NonNull AtomicLong flag)
InferenceCallable(@NonNull VocabCache<VocabWord> vocabCache, @NonNull TokenizerFactory tokenizerFactory, @NonNull LabelledDocument document)
InferenceCallable(@NonNull VocabCache<VocabWord> vocabCache, @NonNull TokenizerFactory tokenizerFactory, @NonNull LabelledDocument document, @NonNull AtomicLong flag)

Uses of VocabWord in org.deeplearning4j.models.sequencevectors.serialization

Methods in org.deeplearning4j.models.sequencevectors.serialization that return VocabWord

Modifier and Type	Method	Description
VocabWord	VocabWordFactory.deserialize(String json)	This method builds object from provided JSON

Methods in org.deeplearning4j.models.sequencevectors.serialization with parameters of type VocabWord

Modifier and Type	Method	Description
String	VocabWordFactory.serialize(VocabWord element)	This method serializaes object into JSON string

Uses of VocabWord in org.deeplearning4j.models.sequencevectors.transformers.impl

Fields in org.deeplearning4j.models.sequencevectors.transformers.impl with type parameters of type VocabWord

Modifier and Type	Field	Description
protected VocabCache<VocabWord>	SentenceTransformer.Builder.vocabCache

Methods in org.deeplearning4j.models.sequencevectors.transformers.impl that return types with arguments of type VocabWord

Modifier and Type	Method	Description
Iterator<Sequence<VocabWord>>	SentenceTransformer.iterator()
Sequence<VocabWord>	SentenceTransformer.transformToSequence(String object)

Uses of VocabWord in org.deeplearning4j.models.sequencevectors.transformers.impl.iterables

Fields in org.deeplearning4j.models.sequencevectors.transformers.impl.iterables with type parameters of type VocabWord

Modifier and Type	Field	Description
protected BlockingQueue<Future<Sequence<VocabWord>>>	ParallelTransformerIterator.buffer

Methods in org.deeplearning4j.models.sequencevectors.transformers.impl.iterables that return types with arguments of type VocabWord

Modifier and Type	Method	Description
Sequence<VocabWord>	BasicTransformerIterator.next()
Sequence<VocabWord>	ParallelTransformerIterator.next()

Uses of VocabWord in org.deeplearning4j.models.word2vec

Methods in org.deeplearning4j.models.word2vec that return VocabWord

Modifier and Type	Method	Description
static VocabWord	VocabWord.none()

Methods in org.deeplearning4j.models.word2vec with parameters of type VocabWord

Modifier and Type	Method	Description
Word2Vec.Builder	Word2Vec.Builder.unknownElement(VocabWord element)	This method allows you to specify SequenceElement that will be used as UNK element, if UNK is used

Method parameters in org.deeplearning4j.models.word2vec with type arguments of type VocabWord

Modifier and Type	Method	Description
Word2Vec.Builder	Word2Vec.Builder.elementsLearningAlgorithm(@NonNull ElementsLearningAlgorithm<VocabWord> algorithm)
Word2Vec.Builder	Word2Vec.Builder.iterate(@NonNull SequenceIterator<VocabWord> iterator)	This method used to feed SequenceIterator, that contains training corpus, into ParagraphVectors
Word2Vec.Builder	Word2Vec.Builder.lookupTable(@NonNull WeightLookupTable<VocabWord> lookupTable)	This method allows to define external WeightLookupTable to be used
Word2Vec.Builder	Word2Vec.Builder.modelUtils(@NonNull ModelUtils<VocabWord> modelUtils)	Sets ModelUtils that gonna be used as provider for utility methods: similarity(), wordsNearest(), accuracy(), etc
void	Word2Vec.setSequenceIterator(@NonNull SequenceIterator<VocabWord> iterator)	This method defines SequenceIterator instance, that will be used as training corpus source.
Word2Vec.Builder	Word2Vec.Builder.setVectorsListeners(@NonNull Collection<VectorsListener<VocabWord>> vectorsListeners)	This method sets VectorsListeners for this SequenceVectors model
Word2Vec.Builder	Word2Vec.Builder.stopWords(@NonNull Collection<VocabWord> stopList)	This method defines stop words that should be ignored during training
Word2Vec.Builder	Word2Vec.Builder.vocabCache(@NonNull VocabCache<VocabWord> vocabCache)	This method allows to define external VocabCache to be used

Constructor parameters in org.deeplearning4j.models.word2vec with type arguments of type VocabWord

Constructor	Description
Builder(org.nd4j.linalg.compression.AbstractStorage<Integer> storage, VocabCache<VocabWord> vocabCache)

Uses of VocabWord in org.deeplearning4j.models.word2vec.wordstore.inmemory

Fields in org.deeplearning4j.models.word2vec.wordstore.inmemory with type parameters of type VocabWord

Modifier and Type	Field	Description
Map<String,VocabWord>	InMemoryLookupCache.tokens	Deprecated.
Map<String,VocabWord>	InMemoryLookupCache.vocabs	Deprecated.

Methods in org.deeplearning4j.models.word2vec.wordstore.inmemory that return VocabWord

Modifier and Type	Method	Description
VocabWord	InMemoryLookupCache.elementAtIndex(int index)	Deprecated.
VocabWord	InMemoryLookupCache.tokenFor(long id)	Deprecated.
VocabWord	InMemoryLookupCache.tokenFor(String word)	Deprecated.
VocabWord	InMemoryLookupCache.wordFor(long id)	Deprecated.
VocabWord	InMemoryLookupCache.wordFor(String word)	Deprecated.

Methods in org.deeplearning4j.models.word2vec.wordstore.inmemory that return types with arguments of type VocabWord

Modifier and Type	Method	Description
Map<String,VocabWord>	InMemoryLookupCache.getTokens()	Deprecated.
Map<String,VocabWord>	InMemoryLookupCache.getVocabs()	Deprecated.
Collection<VocabWord>	InMemoryLookupCache.tokens()	Deprecated.
Collection<VocabWord>	InMemoryLookupCache.vocabWords()	Deprecated. Returns all of the vocab word nodes

Methods in org.deeplearning4j.models.word2vec.wordstore.inmemory with parameters of type VocabWord

Modifier and Type	Method	Description
boolean	InMemoryLookupCache.addToken(VocabWord word)	Deprecated.
void	InMemoryLookupCache.removeElement(VocabWord element)	Deprecated.

Method parameters in org.deeplearning4j.models.word2vec.wordstore.inmemory with type arguments of type VocabWord

Modifier and Type	Method	Description
void	InMemoryLookupCache.importVocabulary(VocabCache<VocabWord> vocabCache)	Deprecated.
void	InMemoryLookupCache.setTokens(Map<String,VocabWord> tokens)	Deprecated.
void	InMemoryLookupCache.setVocabs(Map<String,VocabWord> vocabs)	Deprecated.