org.deeplearning4j.models.embeddings.reader

Interface ModelUtils<T extends SequenceElement>

All Known Implementing Classes:

BasicModelUtils, FlatModelUtils, TreeModelUtils

public interface ModelUtils<T extends SequenceElement>

Instances implementing this interface should be responsible for utility access to SequenceVectors model

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Double>	accuracy(java.util.List<java.lang.String> questions) Accuracy based on questions which are a space separated list of strings where the first word is the query word, the next 2 words are negative, and the last word is the predicted word to be nearest
void	init(WeightLookupTable<T> lookupTable) This method implementations should accept given lookup table, and use them in further calls to interface methods
double	similarity(java.lang.String label1, java.lang.String label2) This method implementations should return distance between two given elements
java.util.List<java.lang.String>	similarWordsInVocabTo(java.lang.String word, double accuracy) Find all words with a similar characters in the vocab
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 implementations should return N nearest elements labels to given element's label
java.util.Collection<java.lang.String>	wordsNearestSum(java.util.Collection<java.lang.String> positive, java.util.Collection<java.lang.String> negative, int top)
java.util.Collection<java.lang.String>	wordsNearestSum(org.nd4j.linalg.api.ndarray.INDArray words, int top)
java.util.Collection<java.lang.String>	wordsNearestSum(java.lang.String word, int n)

Method Detail

init

void init(WeightLookupTable<T> lookupTable)

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

Parameters:

lookupTable -

similarity

double similarity(java.lang.String label1,
                  java.lang.String label2)

This method implementations should return distance between two given elements

Parameters:

label1 -

label2 -

Returns:

accuracy

java.util.Map<java.lang.String,java.lang.Double> accuracy(java.util.List<java.lang.String> questions)

Accuracy based on questions which are a space separated list of strings where the first word is the query word, the next 2 words are negative, and the last word is the predicted word to be nearest

Parameters:

questions - the questions to ask

Returns:

the accuracy based on these questions

similarWordsInVocabTo

java.util.List<java.lang.String> similarWordsInVocabTo(java.lang.String word,
                                                       double accuracy)

Find all words with a similar characters in the vocab

Parameters:

word - the word to compare

accuracy - the accuracy: 0 to 1

Returns:

the list of words that are similar in the vocab

wordsNearest

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

This method implementations should return N nearest elements labels to given element's label

Parameters:

label - label to return nearest elements for

n - number of nearest words to return

Returns:

wordsNearest

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

Parameters:

positive - the positive words

negative - the negative words

top - the top n words

Returns:

the words nearest the mean of the words

wordsNearest

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

Returns:

the words nearest the mean of the words

wordsNearestSum

java.util.Collection<java.lang.String> wordsNearestSum(java.lang.String word,
                                                       int n)

wordsNearestSum

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

wordsNearestSum

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