org.deeplearning4j.models.embeddings.inmemory

Class InMemoryLookupTable

java.lang.Object

org.deeplearning4j.models.embeddings.inmemory.InMemoryLookupTable

All Implemented Interfaces:

Serializable, WeightLookupTable

Direct Known Subclasses:

GloveWeightLookupTable

public class InMemoryLookupTable
extends Object
implements WeightLookupTable

Default word lookup table

Author:

Adam Gibson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InMemoryLookupTable.Builder
protected class	InMemoryLookupTable.WeightIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,org.nd4j.linalg.api.ndarray.INDArray>	codes
protected double[]	expTable
protected com.google.common.util.concurrent.AtomicDouble	lr
protected static double	MAX_EXP
protected double	negative
protected org.apache.commons.math3.random.RandomGenerator	rng
protected long	seed
protected org.nd4j.linalg.api.ndarray.INDArray	syn0
protected org.nd4j.linalg.api.ndarray.INDArray	syn1
protected org.nd4j.linalg.api.ndarray.INDArray	syn1Neg
protected org.nd4j.linalg.api.ndarray.INDArray	table
protected boolean	useAdaGrad
protected int	vectorLength
protected VocabCache	vocab

Constructor Summary

Constructors

Constructor and Description
InMemoryLookupTable(VocabCache vocab, int vectorLength, boolean useAdaGrad, double lr, org.apache.commons.math3.random.RandomGenerator gen, double negative)

Method Summary

Modifier and Type	Method and Description
Map<Integer,org.nd4j.linalg.api.ndarray.INDArray>	getCodes()
com.google.common.util.concurrent.AtomicDouble	getLr()
double	getNegative()
org.nd4j.linalg.api.ndarray.INDArray	getSyn0()
org.nd4j.linalg.api.ndarray.INDArray	getSyn1()
org.nd4j.linalg.api.ndarray.INDArray	getSyn1Neg()
org.nd4j.linalg.api.ndarray.INDArray	getTable()
int	getVectorLength()
VocabCache	getVocab()
protected void	initExpTable()
protected void	initNegative()
boolean	isUseAdaGrad()
void	iterate(VocabWord w1, VocabWord w2) Iterate on the given 2 vocab words
void	iterateSample(VocabWord w1, VocabWord w2, AtomicLong nextRandom, double alpha) Iterate on the given 2 vocab words
int	layerSize() The layer size for the lookup table
org.nd4j.linalg.api.ndarray.INDArray	loadCodes(int[] codes) Loads the co-occurrences for the given codes
protected void	makeTable(int tableSize, double power)
void	plotVocab() Render the words via tsne
void	plotVocab(Tsne tsne) Render the words via TSNE
void	putCode(int codeIndex, org.nd4j.linalg.api.ndarray.INDArray code)
void	putVector(String word, org.nd4j.linalg.api.ndarray.INDArray vector) Inserts a word vector
void	resetWeights() Reset the weights of the cache
void	resetWeights(boolean reset) Clear out all weights regardless
void	setCodes(Map<Integer,org.nd4j.linalg.api.ndarray.INDArray> codes)
void	setLearningRate(double lr) Sets the learning rate
void	setLr(com.google.common.util.concurrent.AtomicDouble lr)
void	setNegative(double negative)
void	setSyn0(org.nd4j.linalg.api.ndarray.INDArray syn0)
void	setSyn1(org.nd4j.linalg.api.ndarray.INDArray syn1)
void	setSyn1Neg(org.nd4j.linalg.api.ndarray.INDArray syn1Neg)
void	setTable(org.nd4j.linalg.api.ndarray.INDArray table)
void	setUseAdaGrad(boolean useAdaGrad)
void	setVectorLength(int vectorLength)
void	setVocab(VocabCache vocab)
org.nd4j.linalg.api.ndarray.INDArray	vector(String word)
Iterator<org.nd4j.linalg.api.ndarray.INDArray>	vectors() Iterates through all of the vectors in the cache

Methods inherited from class java.lang.Object

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

Field Detail

syn0

protected org.nd4j.linalg.api.ndarray.INDArray syn0

syn1

protected org.nd4j.linalg.api.ndarray.INDArray syn1

vectorLength

protected int vectorLength

rng

protected transient org.apache.commons.math3.random.RandomGenerator rng

lr

protected com.google.common.util.concurrent.AtomicDouble lr

expTable

protected double[] expTable

MAX_EXP

protected static double MAX_EXP

seed

protected long seed

table

protected org.nd4j.linalg.api.ndarray.INDArray table

syn1Neg

protected org.nd4j.linalg.api.ndarray.INDArray syn1Neg

useAdaGrad

protected boolean useAdaGrad

negative

protected double negative

vocab

protected VocabCache vocab

codes

protected Map<Integer,org.nd4j.linalg.api.ndarray.INDArray> codes

Constructor Detail

InMemoryLookupTable

public InMemoryLookupTable(VocabCache vocab,
                           int vectorLength,
                           boolean useAdaGrad,
                           double lr,
                           org.apache.commons.math3.random.RandomGenerator gen,
                           double negative)

Method Detail

layerSize

public int layerSize()

Description copied from interface: WeightLookupTable

The layer size for the lookup table

Specified by:

layerSize in interface WeightLookupTable

Returns:

the layer size for the lookup table

resetWeights

public void resetWeights(boolean reset)

Description copied from interface: WeightLookupTable

Clear out all weights regardless

Specified by:

resetWeights in interface WeightLookupTable

plotVocab

public void plotVocab(Tsne tsne)

Description copied from interface: WeightLookupTable

Render the words via TSNE

Specified by:

plotVocab in interface WeightLookupTable

Parameters:

tsne - the tsne to use

plotVocab

public void plotVocab()

Render the words via tsne

Specified by:

plotVocab in interface WeightLookupTable

putCode

public void putCode(int codeIndex,
                    org.nd4j.linalg.api.ndarray.INDArray code)

Specified by:

putCode in interface WeightLookupTable

Parameters:

codeIndex -

code -

loadCodes

public org.nd4j.linalg.api.ndarray.INDArray loadCodes(int[] codes)

Loads the co-occurrences for the given codes

Specified by:

loadCodes in interface WeightLookupTable

Parameters:

codes - the codes to load

Returns:

an ndarray of code.length by layerSize

initNegative

protected void initNegative()

initExpTable

protected void initExpTable()

iterateSample

public void iterateSample(VocabWord w1,
                          VocabWord w2,
                          AtomicLong nextRandom,
                          double alpha)

Iterate on the given 2 vocab words

Specified by:

iterateSample in interface WeightLookupTable

Parameters:

w1 - the first word to iterate on

w2 - the second word to iterate on

nextRandom - next random for sampling

alpha - the alpha to use for learning

isUseAdaGrad

public boolean isUseAdaGrad()

setUseAdaGrad

public void setUseAdaGrad(boolean useAdaGrad)

getNegative

public double getNegative()

setNegative

public void setNegative(double negative)

iterate

public void iterate(VocabWord w1,
                    VocabWord w2)

Iterate on the given 2 vocab words

Specified by:

iterate in interface WeightLookupTable

Parameters:

w1 - the first word to iterate on

w2 - the second word to iterate on

resetWeights

public void resetWeights()

Reset the weights of the cache

Specified by:

resetWeights in interface WeightLookupTable

makeTable

protected void makeTable(int tableSize,
                         double power)

putVector

public void putVector(String word,
                      org.nd4j.linalg.api.ndarray.INDArray vector)

Inserts a word vector

Specified by:

putVector in interface WeightLookupTable

Parameters:

word - the word to insert

vector - the vector to insert

getTable

public org.nd4j.linalg.api.ndarray.INDArray getTable()

setTable

public void setTable(org.nd4j.linalg.api.ndarray.INDArray table)

getSyn1Neg

public org.nd4j.linalg.api.ndarray.INDArray getSyn1Neg()

setSyn1Neg

public void setSyn1Neg(org.nd4j.linalg.api.ndarray.INDArray syn1Neg)

vector

public org.nd4j.linalg.api.ndarray.INDArray vector(String word)

Specified by:

vector in interface WeightLookupTable

Parameters:

word -

Returns:

setLearningRate

public void setLearningRate(double lr)

Description copied from interface: WeightLookupTable

Sets the learning rate

Specified by:

setLearningRate in interface WeightLookupTable

vectors

public Iterator<org.nd4j.linalg.api.ndarray.INDArray> vectors()

Description copied from interface: WeightLookupTable

Iterates through all of the vectors in the cache

Specified by:

vectors in interface WeightLookupTable

Returns:

an iterator for all vectors in the cache

getSyn0

public org.nd4j.linalg.api.ndarray.INDArray getSyn0()

setSyn0

public void setSyn0(org.nd4j.linalg.api.ndarray.INDArray syn0)

getSyn1

public org.nd4j.linalg.api.ndarray.INDArray getSyn1()

setSyn1

public void setSyn1(org.nd4j.linalg.api.ndarray.INDArray syn1)

getVectorLength

public int getVectorLength()

setVectorLength

public void setVectorLength(int vectorLength)

getLr

public com.google.common.util.concurrent.AtomicDouble getLr()

setLr

public void setLr(com.google.common.util.concurrent.AtomicDouble lr)

getVocab

public VocabCache getVocab()

setVocab

public void setVocab(VocabCache vocab)

getCodes

public Map<Integer,org.nd4j.linalg.api.ndarray.INDArray> getCodes()

setCodes

public void setCodes(Map<Integer,org.nd4j.linalg.api.ndarray.INDArray> codes)