abstract class Evaluator extends Params
Abstract class for evaluators that compute metrics from predictions.
- Annotations
- @Since( "1.5.0" )
- Source
- Evaluator.scala
- Alphabetic
- By Inheritance
- Evaluator
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Evaluator()
Abstract Value Members
-
abstract
def
copy(extra: ParamMap): Evaluator
Creates a copy of this instance with the same UID and some extra params.
-
abstract
def
evaluate(dataset: Dataset[_]): Double
Evaluates model output and returns a scalar metric.
Evaluates model output and returns a scalar metric. The value of isLargerBetter specifies whether larger values are better.
- dataset
a dataset that contains labels/observations and predictions.
- returns
metric
- Annotations
- @Since( "2.0.0" )
-
abstract
val
uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
- Definition Classes
- Identifiable
Concrete Value Members
-
final
def
clear(param: Param[_]): Evaluator.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
- Definition Classes
- Params
-
def
evaluate(dataset: Dataset[_], paramMap: ParamMap): Double
Evaluates model output and returns a scalar metric.
Evaluates model output and returns a scalar metric. The value of isLargerBetter specifies whether larger values are better.
- dataset
a dataset that contains labels/observations and predictions.
- paramMap
parameter map that specifies the input columns and output metrics
- returns
metric
- Annotations
- @Since( "2.0.0" )
-
def
explainParam(param: Param[_]): String
Explains a param.
Explains a param.
- param
input param, must belong to this instance.
- returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
- Definition Classes
- Params
-
def
explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See
explainParam()
.- Definition Classes
- Params
-
final
def
extractParamMap(): ParamMap
extractParamMap
with no extra values.extractParamMap
with no extra values.- Definition Classes
- Params
-
final
def
extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
- Definition Classes
- Params
-
final
def
get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
- Definition Classes
- Params
-
final
def
getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
- Definition Classes
- Params
-
final
def
getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
- Definition Classes
- Params
-
def
getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
- Definition Classes
- Params
-
final
def
hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
- Definition Classes
- Params
-
def
hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
- Definition Classes
- Params
-
final
def
isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
- Definition Classes
- Params
-
def
isLargerBetter: Boolean
Indicates whether the metric returned by
evaluate
should be maximized (true, default) or minimized (false).Indicates whether the metric returned by
evaluate
should be maximized (true, default) or minimized (false). A given evaluator may support multiple metrics which may be maximized or minimized.- Annotations
- @Since( "1.5.0" )
-
final
def
isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
- Definition Classes
- Params
-
lazy val
params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
- Definition Classes
- Params
- Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
-
final
def
set[T](param: Param[T], value: T): Evaluator.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
- Definition Classes
- Params
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any