Class MetricTarget<T extends Output<T>>

java.lang.Object

org.tribuo.evaluation.metrics.MetricTarget<T>

Type Parameters:

T - The Output type.

public class MetricTarget<T extends Output<T>>
extends Object

Used by a given EvaluationMetric to determine whether it should compute its value for a specific Output value or whether it should average them.

Constructor Summary

Constructors

Constructor	Description
MetricTarget(EvaluationMetric.Average avg)	Builds a metric target for an average.
MetricTarget(T target)	Builds a metric target for an output.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<EvaluationMetric.Average>	getAverageTarget()	Returns the average this metric computes, or Optional.empty() if it targets an output.
Optional<T>	getOutputTarget()	Returns the Output this metric targets, or Optional.empty() if it's an average.
int	hashCode()
static <U extends Output<U>> MetricTarget<U>	macroAverageTarget()	Get the singleton MetricTarget which contains the EvaluationMetric.Average.MACRO.
static <U extends Output<U>> MetricTarget<U>	microAverageTarget()	Get the singleton MetricTarget which contains the EvaluationMetric.Average.MICRO.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricTarget

public MetricTarget(T target)

Builds a metric target for an output.

Parameters:

target - The output to target.

MetricTarget

public MetricTarget(EvaluationMetric.Average avg)

Builds a metric target for an average.

Parameters:

avg - The average to compute.

Method Details

getOutputTarget

public Optional<T> getOutputTarget()

Returns the Output this metric targets, or Optional.empty() if it's an average.

Returns:

The output this metric targets, or Optional.empty().

getAverageTarget

public Optional<EvaluationMetric.Average> getAverageTarget()

Returns the average this metric computes, or Optional.empty() if it targets an output.

Returns:

The average this metric computes, or Optional.empty().

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

macroAverageTarget

public static <U extends Output<U>> MetricTarget<U> macroAverageTarget()

Get the singleton MetricTarget which contains the EvaluationMetric.Average.MACRO.

Type Parameters:

U - The output type of the MetricTarget

Returns:

The MetricTarget that provides a macro average.

microAverageTarget

public static <U extends Output<U>> MetricTarget<U> microAverageTarget()

Get the singleton MetricTarget which contains the EvaluationMetric.Average.MICRO.

Type Parameters:

U - The output type of the MetricTarget

Returns:

The MetricTarget that provides a micro average.