Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe.evaluation

Class EvaluationFields

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.evaluation.EvaluationFields

public final class EvaluationFields
extends Object

Encapsulates fields needed by evaluation.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	ACTUAL_FIELD
static final ParseField	PREDICTED_CLASS_FIELD
static final ParseField	PREDICTED_FIELD
static final ParseField	PREDICTED_PROBABILITY_FIELD
static final ParseField	TOP_CLASSES_FIELD

Constructor Summary

Constructors

Constructor	Description
EvaluationFields(String actualField, String predictedField, String topClassesField, String predictedClassField, String predictedProbabilityField, boolean predictedProbabilityFieldNested)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getActualField()	Returns the field containing the actual value
String	getPredictedClassField()	Returns the field containing the predicted class name value
String	getPredictedField()	Returns the field containing the predicted value
String	getPredictedProbabilityField()	Returns the field containing the predicted probability value in [0.0, 1.0]
String	getTopClassesField()	Returns the field containing the array of top classes
int	hashCode()
boolean	isPredictedProbabilityFieldNested()	Returns whether the predictedProbabilityField should be treated as nested (e.g.: when used in exists queries).
List<Tuple<String,String>>	listPotentiallyRequiredFields()

Methods inherited from class java.lang.Object

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

Field Details

ACTUAL_FIELD

public static final ParseField ACTUAL_FIELD

PREDICTED_FIELD

public static final ParseField PREDICTED_FIELD

TOP_CLASSES_FIELD

public static final ParseField TOP_CLASSES_FIELD

PREDICTED_CLASS_FIELD

public static final ParseField PREDICTED_CLASS_FIELD

PREDICTED_PROBABILITY_FIELD

public static final ParseField PREDICTED_PROBABILITY_FIELD

Constructor Details

EvaluationFields

public EvaluationFields(@Nullable
 String actualField,
 @Nullable
 String predictedField,
 @Nullable
 String topClassesField,
 @Nullable
 String predictedClassField,
 @Nullable
 String predictedProbabilityField,
 boolean predictedProbabilityFieldNested)

Method Details

getActualField

public String getActualField()

Returns the field containing the actual value

getPredictedField

public String getPredictedField()

Returns the field containing the predicted value

getTopClassesField

public String getTopClassesField()

Returns the field containing the array of top classes

getPredictedClassField

public String getPredictedClassField()

Returns the field containing the predicted class name value

getPredictedProbabilityField

public String getPredictedProbabilityField()

Returns the field containing the predicted probability value in [0.0, 1.0]

isPredictedProbabilityFieldNested

public boolean isPredictedProbabilityFieldNested()

Returns whether the predictedProbabilityField should be treated as nested (e.g.: when used in exists queries).

listPotentiallyRequiredFields

public List<Tuple<String,String>> listPotentiallyRequiredFields()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object