Interface Inference

forge-lda/src/forge/lda/lda/inference/Inference.java:24–61

import java.util.List;

public interface Inference {
    /**
     * Set up for inference.
     * @param lda
     */
    void setUp(LDA lda);
    
    /**
     * Set up for inference.
     * The configuration is read from properties class.
     * @param lda
     * @param properties
     */
    void setUp(LDA lda, InferenceProperties properties);
    
    /**
     * Run model inference.
     */
    void run();
    
    /**
     * Get the value of doc-topic probability \theta_{docID, topicID}.
     * @param docID
     * @param topicID
     * @return the value of doc-topic probability
     */
    double getTheta(final int docID, final int topicID);
    
    /**
     * Get the value of topic-vocab probability \phi_{topicID, vocabID}.
     * @param topicID
     * @param vocabID
     * @return the value of topic-vocab probability
     */
    double getPhi(final int topicID, final int vocabID);

    public List<Pair<String, Double>> getVocabsSortedByPhi(int topicID);
}