EvaluationBinary.Metric (nd4j-api 1.0.0-M1.1 API)

java.lang.Object
- java.lang.Enum<EvaluationBinary.Metric>
- - org.nd4j.evaluation.classification.EvaluationBinary.Metric

All Implemented Interfaces:

Serializable, Comparable<EvaluationBinary.Metric>, IMetric

Enclosing class:

EvaluationBinary
```
public static enum EvaluationBinary.Metric
extends Enum<EvaluationBinary.Metric>
implements IMetric
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

ACCURACY

F1

FAR

GMEASURE

MCC

PRECISION

RECALL

Enum Constants
Enum Constant and Description
`ACCURACY`
`F1`
`FAR`
`GMEASURE`
`MCC`
`PRECISION`
`RECALL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Class<? extends IEvaluation>`	`getEvaluationClass()` The `IEvaluation` class this metric is for
`boolean`	`minimize()` Whether this metric should be minimized (aka whether lower values are better).
`static EvaluationBinary.Metric`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EvaluationBinary.Metric[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ACCURACY
```
public static final EvaluationBinary.Metric ACCURACY
```
  - F1
```
public static final EvaluationBinary.Metric F1
```
  - PRECISION
```
public static final EvaluationBinary.Metric PRECISION
```
  - RECALL
```
public static final EvaluationBinary.Metric RECALL
```
  - GMEASURE
```
public static final EvaluationBinary.Metric GMEASURE
```
  - MCC
```
public static final EvaluationBinary.Metric MCC
```
  - FAR
```
public static final EvaluationBinary.Metric FAR
```
- Method Detail
  - values
```
public static EvaluationBinary.Metric[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EvaluationBinary.Metric c : EvaluationBinary.Metric.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EvaluationBinary.Metric valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getEvaluationClass
```
public Class<? extends IEvaluation> getEvaluationClass()
```
    Description copied from interface: IMetric
    
    The IEvaluation class this metric is for
    
    Specified by:
    
    getEvaluationClass in interface IMetric
  - minimize
```
public boolean minimize()
```
    Description copied from interface: IMetric
    
    Whether this metric should be minimized (aka whether lower values are better).
    
    Specified by:
    
    minimize in interface IMetric

Enum EvaluationBinary.Metric

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ACCURACY

F1

PRECISION

RECALL

GMEASURE

MCC

FAR

Method Detail

values

valueOf

getEvaluationClass

minimize