org.deeplearning4j.models.embeddings.reader.impl

Class TreeModelUtils<T extends SequenceElement>

java.lang.Object

org.deeplearning4j.models.embeddings.reader.impl.BasicModelUtils<T>

org.deeplearning4j.models.embeddings.reader.impl.TreeModelUtils<T>

All Implemented Interfaces:

ModelUtils<T>

public class TreeModelUtils<T extends SequenceElement>
extends BasicModelUtils<T>

This is VPTree-based implementation for wordsNearest method, suited for multiple consequent calls. Please note: VPTree will take some memory, dependant on your model size.

Nested Class Summary

Nested classes/interfaces inherited from class org.deeplearning4j.models.embeddings.reader.impl.BasicModelUtils

BasicModelUtils.ArrayComparator, BasicModelUtils.SimilarityComparator, BasicModelUtils.WordSimilarity

Field Summary

Fields

Modifier and Type	Field and Description
protected VPTree	vpTree

Fields inherited from class org.deeplearning4j.models.embeddings.reader.impl.BasicModelUtils

CORRECT, EXISTS, lookupTable, normalized, vocabCache, WRONG

Constructor Summary

Constructors

Constructor and Description
TreeModelUtils()

Method Summary

Modifier and Type	Method and Description
protected void	checkTree()
void	init(WeightLookupTable<T> lookupTable) This method implementations should accept given lookup table, and use them in further calls to interface methods
java.util.Collection<java.lang.String>	wordsNearest(java.util.Collection<java.lang.String> positive, java.util.Collection<java.lang.String> negative, int top) Words nearest based on positive and negative words
java.util.Collection<java.lang.String>	wordsNearest(org.nd4j.linalg.api.ndarray.INDArray words, int top) Words nearest based on positive and negative words * @param top the top n words
java.util.Collection<java.lang.String>	wordsNearest(java.lang.String label, int n) This method returns nearest words for target word, based on tree structure.

Methods inherited from class org.deeplearning4j.models.embeddings.reader.impl.BasicModelUtils

accuracy, getLabels, similarity, similarWordsInVocabTo, wordsNearestSum, wordsNearestSum, wordsNearestSum

Methods inherited from class java.lang.Object

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

Field Detail

vpTree

protected VPTree vpTree

Constructor Detail

TreeModelUtils

public TreeModelUtils()

Method Detail

init

public void init(@NonNull
                 WeightLookupTable<T> lookupTable)

Description copied from interface: ModelUtils

This method implementations should accept given lookup table, and use them in further calls to interface methods

Specified by:

init in interface ModelUtils<T extends SequenceElement>

Overrides:

init in class BasicModelUtils<T extends SequenceElement>

checkTree

protected void checkTree()

wordsNearest

public java.util.Collection<java.lang.String> wordsNearest(java.lang.String label,
                                                           int n)

This method returns nearest words for target word, based on tree structure. This method is recommended to use if you're going to call for nearest words multiple times. VPTree will be built upon firt call to this method

Specified by:

wordsNearest in interface ModelUtils<T extends SequenceElement>

Overrides:

wordsNearest in class BasicModelUtils<T extends SequenceElement>

Parameters:

label - label of element we're looking nearest words to

n - number of nearest elements to return

Returns:

wordsNearest

public java.util.Collection<java.lang.String> wordsNearest(java.util.Collection<java.lang.String> positive,
                                                           java.util.Collection<java.lang.String> negative,
                                                           int top)

Description copied from interface: ModelUtils

Words nearest based on positive and negative words

Specified by:

wordsNearest in interface ModelUtils<T extends SequenceElement>

Overrides:

wordsNearest in class BasicModelUtils<T extends SequenceElement>

Parameters:

positive - the positive words

negative - the negative words

top - the top n words

Returns:

the words nearest the mean of the words

wordsNearest

public java.util.Collection<java.lang.String> wordsNearest(org.nd4j.linalg.api.ndarray.INDArray words,
                                                           int top)

Description copied from class: BasicModelUtils

Words nearest based on positive and negative words * @param top the top n words

Specified by:

wordsNearest in interface ModelUtils<T extends SequenceElement>

Overrides:

wordsNearest in class BasicModelUtils<T extends SequenceElement>

Returns:

the words nearest the mean of the words