Package org.deeplearning4j.models.word2vec

Class Word2Vec

java.lang.Object

org.deeplearning4j.models.embeddings.wordvectors.WordVectorsImpl<T>

org.deeplearning4j.models.sequencevectors.SequenceVectors<VocabWord>

org.deeplearning4j.models.word2vec.Word2Vec

All Implemented Interfaces:

Serializable, WordVectors, org.deeplearning4j.nn.weights.embeddings.EmbeddingInitializer

Direct Known Subclasses:

ParagraphVectors

public class Word2Vec
extends SequenceVectors<VocabWord>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Word2Vec.Builder

Nested classes/interfaces inherited from class org.deeplearning4j.models.sequencevectors.SequenceVectors

SequenceVectors.AsyncSequencer

Field Summary

Fields

Modifier and Type	Field	Description
protected SentenceIterator	sentenceIter
protected TokenizerFactory	tokenizerFactory

Fields inherited from class org.deeplearning4j.models.sequencevectors.SequenceVectors

configuration, configured, elementsLearningAlgorithm, enableScavenger, eventListeners, existingModel, intersectModel, iterator, lockFactor, log, scoreElements, scoreSequences, sequenceLearningAlgorithm, unknownElement, vocabLimit

Fields inherited from class org.deeplearning4j.models.embeddings.wordvectors.WordVectorsImpl

batchSize, DEFAULT_UNK, layerSize, learningRate, learningRateDecayWords, lookupTable, minLearningRate, minWordFrequency, modelUtils, negative, numEpochs, numIterations, resetModel, sampling, seed, stopWords, trainElementsVectors, trainSequenceVectors, useAdeGrad, useUnknown, variableWindows, vocab, window, workers

Constructor Summary

Constructors

Constructor	Description
Word2Vec()

Method Summary

Modifier and Type	Method	Description
static Word2Vec	fromJson(String jsonString)
void	setSentenceIterator(@NonNull SentenceIterator iterator)	This method defines SentenceIterator instance, that will be used as training corpus source
void	setSequenceIterator(@NonNull SequenceIterator<VocabWord> iterator)	This method defines SequenceIterator instance, that will be used as training corpus source.
void	setTokenizerFactory(@NonNull TokenizerFactory tokenizerFactory)	This method defines TokenizerFactory instance to be using during model building
String	toJson()

Methods inherited from class org.deeplearning4j.models.sequencevectors.SequenceVectors

buildVocab, fit, getElementsScore, getSequencesScore, getUNK, getWordVectorMatrix, initLearners, setUNK, trainSequence

Methods inherited from class org.deeplearning4j.models.embeddings.wordvectors.WordVectorsImpl

accuracy, getLayerSize, getWordVector, getWordVectorMatrixNormalized, getWordVectors, getWordVectorsMean, hasWord, indexOf, jsonSerializable, loadWeightsInto, lookupTable, outOfVocabularySupported, setLookupTable, setModelUtils, setVocab, similarity, similarWordsInVocabTo, update, update, vectorSize, vocab, vocabSize, wordsNearest, wordsNearest, wordsNearest, wordsNearestSum, wordsNearestSum, wordsNearestSum

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.deeplearning4j.nn.weights.embeddings.EmbeddingInitializer

jsonSerializable, loadWeightsInto, vectorSize, vocabSize

Methods inherited from interface org.deeplearning4j.models.embeddings.wordvectors.WordVectors

accuracy, getWordVector, getWordVectorMatrixNormalized, getWordVectors, getWordVectorsMean, hasWord, indexOf, lookupTable, outOfVocabularySupported, setModelUtils, similarity, similarWordsInVocabTo, vocab, wordsNearest, wordsNearest, wordsNearest, wordsNearestSum, wordsNearestSum, wordsNearestSum

Field Detail

sentenceIter

protected transient SentenceIterator sentenceIter

tokenizerFactory

protected transient TokenizerFactory tokenizerFactory

Constructor Detail

Word2Vec

public Word2Vec()

Method Detail

setTokenizerFactory

public void setTokenizerFactory(@NonNull
                                @NonNull TokenizerFactory tokenizerFactory)

This method defines TokenizerFactory instance to be using during model building

Parameters:

tokenizerFactory - TokenizerFactory instance

setSentenceIterator

public void setSentenceIterator(@NonNull
                                @NonNull SentenceIterator iterator)

This method defines SentenceIterator instance, that will be used as training corpus source

Parameters:

iterator - SentenceIterator instance

setSequenceIterator

public void setSequenceIterator(@NonNull
                                @NonNull SequenceIterator<VocabWord> iterator)

This method defines SequenceIterator instance, that will be used as training corpus source. Main difference with other iterators here: it allows you to pass already tokenized Sequence for training

Parameters:

iterator -

toJson

public String toJson()
              throws org.nd4j.shade.jackson.core.JsonProcessingException

Throws:

org.nd4j.shade.jackson.core.JsonProcessingException

fromJson

public static Word2Vec fromJson(String jsonString)
                         throws IOException

Throws:

IOException