com.joliciel.talismane.machineLearning.ClassificationEvent 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.util.List;

import com.joliciel.talismane.machineLearning.features.FeatureResult;

/**
 * A single classification event in a training or test corpus, combining the
 * results of feature tests and the correct classification.
 * 
 * @author Assaf Urieli
 *
 */
public class ClassificationEvent {
  private final String classification;
  private final List> featureResults;

  /**
   * Get a ClassificationEvent corresponding to the featureResults and
   * classification provided.
   */
  public ClassificationEvent(List> featureResults, String classification) {
    this.classification = classification;
    this.featureResults = featureResults;
  }

  /**
   * The result of testing the various features on this event.
   */

  public List> getFeatureResults() {
    return featureResults;
  }

  /**
   * The correct classification of this event.
   */

  public String getClassification() {
    return classification;
  }
}