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

java.lang.Object
- java.lang.Enum<RegressionEvaluation.Metric>
- - org.nd4j.evaluation.regression.RegressionEvaluation.Metric

All Implemented Interfaces:

Serializable, Comparable<RegressionEvaluation.Metric>, IMetric

Enclosing class:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description

MAE

MSE

PC

R2

RMSE

RSE

Enum Constants
Enum Constant and Description
`MAE`
`MSE`
`PC`
`R2`
`RMSE`
`RSE`

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 RegressionEvaluation.Metric`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RegressionEvaluation.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
  - MSE
```
public static final RegressionEvaluation.Metric MSE
```
  - MAE
```
public static final RegressionEvaluation.Metric MAE
```
  - RMSE
```
public static final RegressionEvaluation.Metric RMSE
```
  - RSE
```
public static final RegressionEvaluation.Metric RSE
```
  - PC
```
public static final RegressionEvaluation.Metric PC
```
  - R2
```
public static final RegressionEvaluation.Metric R2
```
- Method Detail
  - values
```
public static RegressionEvaluation.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 (RegressionEvaluation.Metric c : RegressionEvaluation.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 RegressionEvaluation.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
    
    Returns:
    
    True if the metric should be minimized, or false if the metric should be maximized. For example, MSE of 0 is best, but R^2 of 1.0 is best

Enum RegressionEvaluation.Metric

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MSE

MAE

RMSE

RSE

PC

R2

Method Detail

values

valueOf

getEvaluationClass

minimize