com.arosbio.ml.metrics.classification.Recall Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of confai Show documentation

Conformal AI package, including all data IO, transformations, machine learning models and predictor classes. Without inclusion of chemistry-dependent code.

There is a newer version: 2.0.0

Show newest version

/*
 * Copyright (C) Aros Bio AB.
 *
 * CPSign is an Open Source Software that is dual licensed to allow you to choose a license that best suits your requirements:
 *
 * 1) GPLv3 (GNU General Public License Version 3) with Additional Terms, including an attribution clause as well as a limitation to use the software for commercial purposes.
 *
 * 2) CPSign Proprietary License that allows you to use CPSign for commercial activities, such as in a revenue-generating operation or environment, or integrate CPSign in your proprietary software without worrying about disclosing the source code of your proprietary software, which is required if you choose to use the software under GPLv3 license. See arosbio.com/cpsign/commercial-license for details.
 */
package com.arosbio.ml.metrics.classification;

import java.util.Map;

import com.arosbio.commons.mixins.Aliased;
import com.arosbio.commons.mixins.Described;
import com.arosbio.ml.metrics.SingleValuedMetric;
import com.google.common.collect.ImmutableMap;

public class Recall implements SingleValuedMetric, PointClassifierMetric, LabelDependent, Described, Aliased { //ProbabilityMetric,  

	public static final String METRIC_NAME = "Recall";
	public static final String[] METRIC_ALIASES = new String[] {"Sensitivity","TPR"};
	public static final String METRIC_DESCRIPTION = "Recall, Sensitivity or True Positive Rate (TPR) - calculated as TP/(TP+FN), where TP=True Positives and FN=False Negatives. Note that the 'positive' label is set to be the last label given to the CLI, or the largest numerical label when using the API.";

	private int positiveClass = LabelDependent.DEFAULT_POS_LABEL;
	private int truePos = 0, falseNeg = 0, numPredsDone=0;

	// CONSTRUCTORS

	public Recall() {}

	public Recall(int positiveClass) {
		this.positiveClass = positiveClass;
	}

	// GETTERS AND SETTERS

	public boolean supportsMulticlass() {
		return false;
	}
	
	@Override
	public String getDescription() {
		return METRIC_DESCRIPTION;
	}
	
	// ADD PREDICTIONS

	/*
	 * Main method for adding the predictions
	 */
	@Override
	public void addPrediction(int observedLabel, int predictedLabel) {
		if (observedLabel == positiveClass) {
			if (predictedLabel==observedLabel)
				truePos++;
			else
				falseNeg++;
		}
		numPredsDone++;
	}

	@Override
	public double getScore() {
		if (numPredsDone <= 0)
			return Double.NaN;
		if (truePos+falseNeg == 0)
			return 0;
		return ((double)truePos)/(truePos+falseNeg);
	}
	

	@Override
	public int getNumExamples() {
		return numPredsDone;
	}

	public void setPositiveLabel(int positiveLabel) {
		if (truePos + falseNeg > 0) {
			throw new IllegalStateException("Cannot change the positive class later on");
		}
		this.positiveClass = positiveLabel;
	}

	public int getPositiveLabel() {
		return positiveClass;
	}

	public String toString() {
		return SingleValuedMetric.toString(this);
	}

	@Override
	public Map asMap() {
			return ImmutableMap.of(METRIC_NAME, getScore());
	}

	@Override
	public String getName() {
		return METRIC_NAME;
	}
	
	@Override
	public String[] getAliases() {
		return METRIC_ALIASES;
	}
	
	@Override
	public Recall clone() {
		Recall clone = new Recall();
		clone.positiveClass=positiveClass;
		return clone;
	}

	@Override
	public void clear() {
		truePos = 0;
		falseNeg = 0;
		numPredsDone = 0;
	}

	@Override
	public boolean goalIsMinimization() {
		return false;
	}

}