Word2Vec.Builder (deeplearning4j-nlp 0.0.3.3 API)

java.lang.Object
- org.deeplearning4j.models.word2vec.Word2Vec.Builder

Direct Known Subclasses:

ParagraphVectors.Builder

Enclosing class:

Word2Vec
```
public static class Word2Vec.Builder
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`batchSize`
`protected DocumentIterator`	`docIter`
`protected InvertedIndex`	`index`
`protected SentenceIterator`	`iter`
`protected int`	`iterations`
`protected int`	`layerSize`
`protected int`	`learningRateDecayWords`
`protected WeightLookupTable`	`lookupTable`
`protected double`	`lr`
`protected double`	`minLearningRate`
`protected int`	`minWordFrequency`
`protected double`	`negative`
`protected double`	`sampling`
`protected boolean`	`saveVocab`
`protected long`	`seed`
`protected List<String>`	`stopWords`
`protected TextVectorizer`	`textVectorizer`
`protected TokenizerFactory`	`tokenizerFactory`
`protected boolean`	`useAdaGrad`
`protected VocabCache`	`vocabCache`
`protected int`	`window`
`protected int`	`workers`

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Word2Vec.Builder`	`batchSize(int batchSize)`
`Word2Vec`	`build()`
`Word2Vec.Builder`	`index(InvertedIndex index)`
`Word2Vec.Builder`	`iterate(DocumentIterator iter)`
`Word2Vec.Builder`	`iterate(SentenceIterator iter)`
`Word2Vec.Builder`	`iterations(int iterations)`
`Word2Vec.Builder`	`layerSize(int layerSize)`
`Word2Vec.Builder`	`learningRate(double lr)`
`Word2Vec.Builder`	`learningRateDecayWords(int learningRateDecayWords)`
`Word2Vec.Builder`	`lookupTable(WeightLookupTable lookupTable)`
`Word2Vec.Builder`	`minLearningRate(double minLearningRate)`
`Word2Vec.Builder`	`minWordFrequency(int minWordFrequency)`
`Word2Vec.Builder`	`negativeSample(double negative)`
`Word2Vec.Builder`	`sampling(double sample)`
`Word2Vec.Builder`	`saveVocab(boolean saveVocab)`
`Word2Vec.Builder`	`seed(long seed)`
`Word2Vec.Builder`	`stopWords(List<String> stopWords)`
`Word2Vec.Builder`	`tokenizerFactory(TokenizerFactory tokenizerFactory)`
`Word2Vec.Builder`	`useAdaGrad(boolean useAdaGrad)`
`Word2Vec.Builder`	`vectorizer(TextVectorizer textVectorizer)`
`Word2Vec.Builder`	`vocabCache(VocabCache cache)`
`Word2Vec.Builder`	`windowSize(int window)`
`Word2Vec.Builder`	`workers(int workers)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minWordFrequency
```
protected int minWordFrequency
```

layerSize
```
protected int layerSize
```

iter
```
protected SentenceIterator iter
```

stopWords
```
protected List<String> stopWords
```

window
```
protected int window
```

tokenizerFactory

protected TokenizerFactory tokenizerFactory

vocabCache
```
protected VocabCache vocabCache
```

docIter
```
protected DocumentIterator docIter
```

lr
```
protected double lr
```

iterations
```
protected int iterations
```

seed
```
protected long seed
```

saveVocab
```
protected boolean saveVocab
```

batchSize
```
protected int batchSize
```

learningRateDecayWords
```
protected int learningRateDecayWords
```

useAdaGrad
```
protected boolean useAdaGrad
```

textVectorizer

protected TextVectorizer textVectorizer

minLearningRate
```
protected double minLearningRate
```

negative
```
protected double negative
```

sampling
```
protected double sampling
```

workers
```
protected int workers
```

index
```
protected InvertedIndex index
```

lookupTable

protected WeightLookupTable lookupTable

Constructor Detail
- Builder
```
public Builder()
```

Method Detail

lookupTable

public Word2Vec.Builder lookupTable(WeightLookupTable lookupTable)

index

public Word2Vec.Builder index(InvertedIndex index)

workers

public Word2Vec.Builder workers(int workers)

sampling

public Word2Vec.Builder sampling(double sample)

negativeSample

public Word2Vec.Builder negativeSample(double negative)

minLearningRate

public Word2Vec.Builder minLearningRate(double minLearningRate)

useAdaGrad

public Word2Vec.Builder useAdaGrad(boolean useAdaGrad)

vectorizer

public Word2Vec.Builder vectorizer(TextVectorizer textVectorizer)

learningRateDecayWords

public Word2Vec.Builder learningRateDecayWords(int learningRateDecayWords)

batchSize

public Word2Vec.Builder batchSize(int batchSize)

saveVocab

public Word2Vec.Builder saveVocab(boolean saveVocab)

seed

public Word2Vec.Builder seed(long seed)

iterations

public Word2Vec.Builder iterations(int iterations)

learningRate

public Word2Vec.Builder learningRate(double lr)

iterate

public Word2Vec.Builder iterate(DocumentIterator iter)

vocabCache

public Word2Vec.Builder vocabCache(VocabCache cache)

minWordFrequency

public Word2Vec.Builder minWordFrequency(int minWordFrequency)

tokenizerFactory

public Word2Vec.Builder tokenizerFactory(TokenizerFactory tokenizerFactory)

layerSize

public Word2Vec.Builder layerSize(int layerSize)

stopWords

public Word2Vec.Builder stopWords(List<String> stopWords)

windowSize

public Word2Vec.Builder windowSize(int window)

iterate

public Word2Vec.Builder iterate(SentenceIterator iter)

build
```
public Word2Vec build()
```

Class Word2Vec.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

minWordFrequency

layerSize

iter

stopWords

window

tokenizerFactory

vocabCache

docIter

lr

iterations

seed

saveVocab

batchSize

learningRateDecayWords

useAdaGrad

textVectorizer

minLearningRate

negative

sampling

workers

index

lookupTable

Constructor Detail

Builder

Method Detail

lookupTable

index

workers

sampling

negativeSample

minLearningRate

useAdaGrad

vectorizer

learningRateDecayWords

batchSize

saveVocab

seed

iterations

learningRate

iterate

vocabCache

minWordFrequency

tokenizerFactory

layerSize

stopWords

windowSize

iterate

build