Package org.deeplearning4j.models.embeddings.learning.impl.elements

Class CBOW<T extends SequenceElement>

java.lang.Object

org.deeplearning4j.models.embeddings.learning.impl.elements.CBOW<T>

All Implemented Interfaces:

ElementsLearningAlgorithm<T>

public class CBOW<T extends SequenceElement>
extends Object
implements ElementsLearningAlgorithm<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected ThreadLocal<List<org.nd4j.linalg.api.ops.aggregates.Aggregate>>	batches
protected org.nd4j.linalg.util.DeviceLocalNDArray	expTable
protected static double	MAX_EXP
protected double	negative
protected double	sampling
protected org.nd4j.linalg.util.DeviceLocalNDArray	syn0
protected org.nd4j.linalg.util.DeviceLocalNDArray	syn1
protected org.nd4j.linalg.util.DeviceLocalNDArray	syn1Neg
protected org.nd4j.linalg.util.DeviceLocalNDArray	table
protected boolean	useAdaGrad
protected int[]	variableWindows
protected int	window
protected int	workers

Constructor Summary

Constructors

Constructor	Description
CBOW()

Method Summary

Modifier and Type	Method	Description
Sequence<T>	applySubsampling(@NonNull Sequence<T> sequence, @NonNull AtomicLong nextRandom)
void	cbow(int i, List<T> sentence, int b, AtomicLong nextRandom, double alpha, int currentWindow, BatchSequences<T> batchSequences)
void	configure(@NonNull VocabCache<T> vocabCache, @NonNull WeightLookupTable<T> lookupTable, @NonNull VectorsConfiguration configuration)
void	finish()
List<org.nd4j.linalg.api.ops.aggregates.Aggregate>	getBatch()
String	getCodeName()
int	getWorkers()
boolean	isEarlyTerminationHit()
void	iterateSample(List<BatchItem<T>> items)
void	iterateSample(T currentWord, int[] windowWords, boolean[] wordStatuses, AtomicLong nextRandom, double alpha, boolean isInference, int numLabels, boolean trainWords, org.nd4j.linalg.api.ndarray.INDArray inferenceVector)
double	learnSequence(Sequence<T> sequence, AtomicLong nextRandom, double learningRate)	This method does training over the sequence of elements passed into it
double	learnSequence(Sequence<T> sequence, AtomicLong nextRandom, double learningRate, BatchSequences<T> batchSequences)
void	pretrain(SequenceIterator<T> iterator)	CBOW doesn't involve any pretraining
void	setWorkers(int workers)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_EXP

protected static double MAX_EXP

window

protected int window

useAdaGrad

protected boolean useAdaGrad

negative

protected double negative

sampling

protected double sampling

variableWindows

protected int[] variableWindows

workers

protected int workers

syn0

protected org.nd4j.linalg.util.DeviceLocalNDArray syn0

syn1

protected org.nd4j.linalg.util.DeviceLocalNDArray syn1

syn1Neg

protected org.nd4j.linalg.util.DeviceLocalNDArray syn1Neg

expTable

protected org.nd4j.linalg.util.DeviceLocalNDArray expTable

table

protected org.nd4j.linalg.util.DeviceLocalNDArray table

batches

protected ThreadLocal<List<org.nd4j.linalg.api.ops.aggregates.Aggregate>> batches

Constructor Detail

CBOW

public CBOW()

Method Detail

getWorkers

public int getWorkers()

setWorkers

public void setWorkers(int workers)

getBatch

public List<org.nd4j.linalg.api.ops.aggregates.Aggregate> getBatch()

getCodeName

public String getCodeName()

Specified by:

getCodeName in interface ElementsLearningAlgorithm<T extends SequenceElement>

configure

public void configure(@NonNull
                      @NonNull VocabCache<T> vocabCache,
                      @NonNull
                      @NonNull WeightLookupTable<T> lookupTable,
                      @NonNull
                      @NonNull VectorsConfiguration configuration)

Specified by:

configure in interface ElementsLearningAlgorithm<T extends SequenceElement>

pretrain

public void pretrain(SequenceIterator<T> iterator)

CBOW doesn't involve any pretraining

Specified by:

pretrain in interface ElementsLearningAlgorithm<T extends SequenceElement>

Parameters:

iterator -

finish

public void finish()

Specified by:

finish in interface ElementsLearningAlgorithm<T extends SequenceElement>

learnSequence

public double learnSequence(Sequence<T> sequence,
                            AtomicLong nextRandom,
                            double learningRate,
                            BatchSequences<T> batchSequences)

Specified by:

learnSequence in interface ElementsLearningAlgorithm<T extends SequenceElement>

learnSequence

public double learnSequence(Sequence<T> sequence,
                            AtomicLong nextRandom,
                            double learningRate)

Description copied from interface: ElementsLearningAlgorithm

This method does training over the sequence of elements passed into it

Specified by:

learnSequence in interface ElementsLearningAlgorithm<T extends SequenceElement>

Returns:

average score for this sequence

isEarlyTerminationHit

public boolean isEarlyTerminationHit()

Specified by:

isEarlyTerminationHit in interface ElementsLearningAlgorithm<T extends SequenceElement>

iterateSample

public void iterateSample(T currentWord,
                          int[] windowWords,
                          boolean[] wordStatuses,
                          AtomicLong nextRandom,
                          double alpha,
                          boolean isInference,
                          int numLabels,
                          boolean trainWords,
                          org.nd4j.linalg.api.ndarray.INDArray inferenceVector)

iterateSample

public void iterateSample(List<BatchItem<T>> items)

cbow

public void cbow(int i,
                 List<T> sentence,
                 int b,
                 AtomicLong nextRandom,
                 double alpha,
                 int currentWindow,
                 BatchSequences<T> batchSequences)

applySubsampling

public Sequence<T> applySubsampling(@NonNull
                                    @NonNull Sequence<T> sequence,
                                    @NonNull
                                    @NonNull AtomicLong nextRandom)