org.deeplearning4j.models.embeddings.learning.ElementsLearningAlgorithm Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deeplearning4j-nlp Show documentation

There is a newer version: 1.0.0-M2.1

package org.deeplearning4j.models.embeddings.learning;

import org.deeplearning4j.models.embeddings.WeightLookupTable;
import org.deeplearning4j.models.embeddings.loader.VectorsConfiguration;
import org.deeplearning4j.models.sequencevectors.interfaces.SequenceIterator;
import org.deeplearning4j.models.sequencevectors.sequence.Sequence;
import org.deeplearning4j.models.sequencevectors.sequence.SequenceElement;
import org.deeplearning4j.models.word2vec.wordstore.VocabCache;
import org.nd4j.linalg.api.ndarray.INDArray;

import java.util.concurrent.atomic.AtomicLong;

/**
 * Implementations of this interface should contain element-related learning algorithms. Like skip-gram, cbow or glove
 *
 * @author [email protected]
 */
public interface ElementsLearningAlgorithm {

    String getCodeName();

    void configure(VocabCache vocabCache, WeightLookupTable lookupTable, VectorsConfiguration configuration);

    void pretrain(SequenceIterator iterator);

    /**
     * This method does training over the sequence of elements passed into it
     *
     * @param sequence
     * @param nextRandom
     * @param learningRate
     * @return average score for this sequence
     */
    double learnSequence(Sequence sequence, AtomicLong nextRandom, double learningRate);

    boolean isEarlyTerminationHit();

    void finish();
}