Class LabelMetric

java.lang.Object

org.tribuo.classification.evaluation.LabelMetric

All Implemented Interfaces:

EvaluationMetric<Label, LabelMetric.Context>

public class LabelMetric
extends Object
implements EvaluationMetric<Label, LabelMetric.Context>

A EvaluationMetric for Labels which calculates the value based on a ConfusionMatrix.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LabelMetric.Context	The context for a LabelMetric is a ConfusionMatrix.

Nested classes/interfaces inherited from interface org.tribuo.evaluation.metrics.EvaluationMetric

EvaluationMetric.Average

Constructor Summary

Constructors

Constructor	Description
LabelMetric(MetricTarget<Label> tgt, String name, ToDoubleBiFunction<MetricTarget<Label>, LabelMetric.Context> impl)	Construct a new LabelMetric for the supplied metric target, using the supplied function.

Method Summary

Modifier and Type	Method	Description
double	compute(LabelMetric.Context context)	Compute the result of this metric from the input context.
LabelMetric.Context	createContext(Model<Label> model, List<Prediction<Label>> predictions)	Creates the context this metric uses to compute it's value.
boolean	equals(Object o)
String	getName()	The name of this metric.
MetricTarget<Label>	getTarget()	The target for this metric instance.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tribuo.evaluation.metrics.EvaluationMetric

createContext, getID

Constructor Details

LabelMetric

public LabelMetric(MetricTarget<Label> tgt,
 String name,
 ToDoubleBiFunction<MetricTarget<Label>, LabelMetric.Context> impl)

Construct a new LabelMetric for the supplied metric target, using the supplied function.

Parameters:

tgt - The metric target.

name - The name of the metric.

impl - The implementing function.

Method Details

compute

public double compute(LabelMetric.Context context)

Description copied from interface: EvaluationMetric

Compute the result of this metric from the input context.

Specified by:

compute in interface EvaluationMetric<Label, LabelMetric.Context>

Parameters:

context - The context to use.

Returns:

The value of the metric.

getTarget

public MetricTarget<Label> getTarget()

Description copied from interface: EvaluationMetric

The target for this metric instance.

Specified by:

getTarget in interface EvaluationMetric<Label, LabelMetric.Context>

Returns:

The metric target.

getName

public String getName()

Description copied from interface: EvaluationMetric

The name of this metric.

Specified by:

getName in interface EvaluationMetric<Label, LabelMetric.Context>

Returns:

The name.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createContext

public LabelMetric.Context createContext(Model<Label> model,
 List<Prediction<Label>> predictions)

Description copied from interface: EvaluationMetric

Creates the context this metric uses to compute it's value.

Specified by:

createContext in interface EvaluationMetric<Label, LabelMetric.Context>

Parameters:

model - The model to use.

predictions - The predictions to use.

Returns:

The metric context.