Package org.deeplearning4j.models.word2vec

Class VocabWord

java.lang.Object

org.deeplearning4j.models.sequencevectors.sequence.SequenceElement

org.deeplearning4j.models.word2vec.VocabWord

All Implemented Interfaces:

Serializable, Comparable<SequenceElement>

public class VocabWord
extends SequenceElement
implements Serializable

Intermediate layers of the neural network

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	affinityId
protected Long	vocabId

Fields inherited from class org.deeplearning4j.models.sequencevectors.sequence.SequenceElement

codeLength, codes, elementFrequency, index, init, isLabel, isLocked, points, sequencesCount, special, storageId

Constructor Summary

Constructors

Constructor	Description
VocabWord()
VocabWord(double wordFrequency, @NonNull String word)
VocabWord(double wordFrequency, @NonNull String word, long storageId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Equals method override should be properly implemented for any extended class, otherwise it will be based on label equality
String	getLabel()	This method should return string representation of this SequenceElement, so it can be used for
String	getWord()
int	hashCode()	hashCode method override should be properly implemented for any extended class, otherwise it will be based on label hashCode
static VocabWord	none()
void	setWord(String word)
String	toJSON()
String	toString()

Methods inherited from class org.deeplearning4j.models.sequencevectors.sequence.SequenceElement

compareTo, getCodeLength, getCodes, getElementFrequency, getGradient, getHistoricalGradient, getIndex, getLongHash, getPoints, getSequencesCount, getStorageId, increaseElementFrequency, incrementElementFrequency, incrementSequencesCount, incrementSequencesCount, isLabel, mapper, markAsLabel, setCodeLength, setCodes, setElementFrequency, setHistoricalGradient, setIndex, setPoints, setPoints, setSequencesCount

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

vocabId

protected Long vocabId

affinityId

protected Long affinityId

Constructor Detail

VocabWord

public VocabWord(double wordFrequency,
                 @NonNull
                 @NonNull String word)

Parameters:

wordFrequency - count of the word

VocabWord

public VocabWord(double wordFrequency,
                 @NonNull
                 @NonNull String word,
                 long storageId)

VocabWord

public VocabWord()

Method Detail

none

public static VocabWord none()

getLabel

public String getLabel()

Description copied from class: SequenceElement

This method should return string representation of this SequenceElement, so it can be used for

Specified by:

getLabel in class SequenceElement

Returns:

getWord

public String getWord()

setWord

public void setWord(String word)

equals

public boolean equals(Object o)

Description copied from class: SequenceElement

Equals method override should be properly implemented for any extended class, otherwise it will be based on label equality

Overrides:

equals in class SequenceElement

hashCode

public int hashCode()

Description copied from class: SequenceElement

hashCode method override should be properly implemented for any extended class, otherwise it will be based on label hashCode

Overrides:

hashCode in class SequenceElement

Returns:

hashCode for this SequenceElement

toString

public String toString()

Overrides:

toString in class SequenceElement

toJSON

public String toJSON()

Specified by:

toJSON in class SequenceElement

Returns: