org.jpmml.evaluator.CategoricalResultFeature Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015 Villu Ruusmann
 *
 * This file is part of JPMML-Evaluator
 *
 * JPMML-Evaluator 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.
 *
 * JPMML-Evaluator 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 JPMML-Evaluator.  If not, see .
 */
package org.jpmml.evaluator;

import java.util.Set;

import org.dmg.pmml.clustering.Cluster;
import org.dmg.pmml.clustering.ClusteringModel;
import org.dmg.pmml.nearest_neighbor.NearestNeighborModel;

/**
 * 
 * A common superinterface for categorical result features.
 * 
 *
 * 
 * Classification is a supervised learning task.
 * The set of all categories is defined by the range of categories of the target field.
 * 
 *
 * 
 * Clustering is an unsupervised learning task.
 * The set of all categories is defined by the identifiers of reference entities.
 * For {@link ClusteringModel clustering models} this includes all {@link Cluster clusters}.
 * For {@link NearestNeighborModel k-nearest neighbor models} this includes k nearest training instances.
 * 
 *
 * @see TargetField#getCategories()
 */
public interface CategoricalResultFeature extends ResultFeature {

	/**
	 * 
	 * Gets the set of known categories.
	 * 
	 *
	 * 
	 * The set of known categories either equals the set of all categories, or is a proper subset of it.
	 * 
	 */
	Set getCategories();
}