org.deeplearning4j.models.embeddings.learning.ElementsLearningAlgorithm 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.learning;
import org.deeplearning4j.models.embeddings.WeightLookupTable;
import org.deeplearning4j.models.embeddings.learning.impl.elements.BatchSequences;
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 java.util.concurrent.atomic.AtomicLong;
/**
* Implementations of this interface should contain element-related learning algorithms. Like skip-gram or cbow
*
* @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);
double learnSequence(Sequence sequence, AtomicLong nextRandom, double learningRate, BatchSequences batchSequences);
boolean isEarlyTerminationHit();
void finish();
}