org.deeplearning4j.models.embeddings.reader.ModelUtils Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015-2018 Skymind, Inc.
*
* This program and the accompanying materials are made available under the
* terms of the Apache License, Version 2.0 which is available at
* https://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
* SPDX-License-Identifier: Apache-2.0
******************************************************************************/
package org.deeplearning4j.models.embeddings.reader;
import org.deeplearning4j.models.embeddings.WeightLookupTable;
import org.deeplearning4j.models.sequencevectors.sequence.SequenceElement;
import org.nd4j.linalg.api.ndarray.INDArray;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
* Instances implementing this interface should be responsible for utility access to SequenceVectors model
*
* @author [email protected]
*/
public interface ModelUtils {
/**
* This method implementations should accept given lookup table, and use them in further calls to interface methods
*
* @param lookupTable
*/
void init(WeightLookupTable lookupTable);
/**
* This method implementations should return distance between two given elements
*
* @param label1
* @param label2
* @return
*/
double similarity(String label1, String label2);
/**
* 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
* @param questions the questions to ask
* @return the accuracy based on these questions
*/
Map accuracy(List questions);
/**
* Find all words with a similar characters
* in the vocab
* @param word the word to compare
* @param accuracy the accuracy: 0 to 1
* @return the list of words that are similar in the vocab
*/
List similarWordsInVocabTo(String word, double accuracy);
/**
* This method implementations should return N nearest elements labels to given element's label
*
* @param label label to return nearest elements for
* @param n number of nearest words to return
* @return
*/
Collection wordsNearest(String label, int n);
/**
* Words nearest based on positive and negative words
*
* @param positive the positive words
* @param negative the negative words
* @param top the top n words
* @return the words nearest the mean of the words
*/
Collection wordsNearest(Collection positive, Collection negative, int top);
/**
* Words nearest based on positive and negative words
* * @param top the top n words
* @return the words nearest the mean of the words
*/
Collection wordsNearest(INDArray words, int top);
Collection wordsNearestSum(String word, int n);
Collection wordsNearestSum(INDArray words, int top);
Collection wordsNearestSum(Collection positive, Collection negative, int top);
}