org.deeplearning4j.models.glove

Class AbstractCoOccurrences.Builder<T extends SequenceElement>

java.lang.Object

org.deeplearning4j.models.glove.AbstractCoOccurrences.Builder<T>

Enclosing class:

AbstractCoOccurrences<T extends SequenceElement>

public static class AbstractCoOccurrences.Builder<T extends SequenceElement>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected long	maxmemory
protected SequenceIterator<T>	sequenceIterator
protected boolean	symmetric
protected java.io.File	target
protected VocabCache<T>	vocabCache
protected int	windowSize
protected int	workers

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AbstractCoOccurrences<T>	build()
AbstractCoOccurrences.Builder<T>	iterate(SequenceIterator<T> iterator)
AbstractCoOccurrences.Builder<T>	maxMemory(int gbytes) This method allows you to specify maximum memory available for CoOccurrence map builder.
AbstractCoOccurrences.Builder<T>	symmetric(boolean reallySymmetric)
AbstractCoOccurrences.Builder<T>	targetFile(java.io.File file) Path to save cooccurrence map after construction.
AbstractCoOccurrences.Builder<T>	targetFile(java.lang.String path) Path to save cooccurrence map after construction.
AbstractCoOccurrences.Builder<T>	vocabCache(VocabCache<T> cache)
AbstractCoOccurrences.Builder<T>	windowSize(int windowSize)
AbstractCoOccurrences.Builder<T>	workers(int numWorkers)

Methods inherited from class java.lang.Object

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

Field Detail

symmetric

protected boolean symmetric

windowSize

protected int windowSize

vocabCache

protected VocabCache<T extends SequenceElement> vocabCache

sequenceIterator

protected SequenceIterator<T extends SequenceElement> sequenceIterator

workers

protected int workers

target

protected java.io.File target

maxmemory

protected long maxmemory

Constructor Detail

Builder

public Builder()

Method Detail

symmetric

public AbstractCoOccurrences.Builder<T> symmetric(boolean reallySymmetric)

windowSize

public AbstractCoOccurrences.Builder<T> windowSize(int windowSize)

vocabCache

public AbstractCoOccurrences.Builder<T> vocabCache(@NonNull
                                                   VocabCache<T> cache)

iterate

public AbstractCoOccurrences.Builder<T> iterate(@NonNull
                                                SequenceIterator<T> iterator)

workers

public AbstractCoOccurrences.Builder<T> workers(int numWorkers)

maxMemory

public AbstractCoOccurrences.Builder<T> maxMemory(int gbytes)

This method allows you to specify maximum memory available for CoOccurrence map builder. Please note: this option can be considered a debugging method. In most cases setting proper -Xmx argument set to JVM is enough to limit this algorithm. Please note: this option won't override -Xmx JVM value.

Parameters:

gbytes - memory available, in GigaBytes

Returns:

targetFile

public AbstractCoOccurrences.Builder<T> targetFile(@NonNull
                                                   java.lang.String path)

Path to save cooccurrence map after construction. If targetFile is not specified, temporary file will be used.

Parameters:

path -

Returns:

targetFile

public AbstractCoOccurrences.Builder<T> targetFile(@NonNull
                                                   java.io.File file)

Path to save cooccurrence map after construction. If targetFile is not specified, temporary file will be used.

Parameters:

file -

Returns:

build

public AbstractCoOccurrences<T> build()