com.joliciel.talismane.machineLearning.ClassificationModelTrainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of talismane-machine-learning Show documentation

There is a newer version: 6.1.8

Show newest version

///////////////////////////////////////////////////////////////////////////////
//Copyright (C) 2014 Joliciel Informatique
//
//This file is part of Talismane.
//
//Talismane is free software: you can redistribute it and/or modify
//it under the terms of the GNU Affero General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.
//
//Talismane is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU Affero General Public License for more details.
//
//You should have received a copy of the GNU Affero General Public License
//along with Talismane.  If not, see .
//////////////////////////////////////////////////////////////////////////////
package com.joliciel.talismane.machineLearning;

import java.io.IOException;
import java.util.List;
import java.util.Map;

import com.joliciel.talismane.TalismaneException;
import com.typesafe.config.Config;

/**
 * Trains a machine learning classification model for a given CorpusEventStream.
 * 
 * @author Assaf Urieli
 *
 */
public interface ClassificationModelTrainer {
  /**
   * Return the ClassificationModel trained using the CorpusEventStream
   * provided.
   * 
   * @param corpusEventStream
   *          the event stream containing the events to be used for training
   * @param featureDescriptors
   *          the feature descriptors required to apply this model to new data.
   * @throws TalismaneException
   * @throws IOException
   */
  public ClassificationModel trainModel(ClassificationEventStream corpusEventStream, List featureDescriptors) throws TalismaneException, IOException;

  /**
   * Return the ClassificationModel trained using the CorpusEventStream
   * provided.
   * 
   * @param corpusEventStream
   *          the event stream containing the events to be used for training
   * @param descriptors
   *          all of the descriptors required to perform analysis using this
   *          model (e.g. feature descriptors, etc.)
   * @throws TalismaneException
   * @throws IOException
   */
  public ClassificationModel trainModel(ClassificationEventStream corpusEventStream, Map> descriptors)
      throws TalismaneException, IOException;

  /**
   * Statistical cutoff for feature inclusion: features must appear at least
   * this many times to be included in the model. Note that for numeric
   * features, any value > 0 counts as 1 occurrence for cutoff purposes.
   */
  public int getCutoff();

  public void setCutoff(int cutoff);

  /**
   * Set parameters for this trainer type.
   */
  public void setParameters(Config config);
}