MultilabelClassificationEvaluator#

class pyspark.ml.evaluation.MultilabelClassificationEvaluator(*, predictionCol='prediction', labelCol='label', metricName='f1Measure', metricLabel=0.0)[source]#

Evaluator for Multilabel Classification, which expects two input columns: prediction and label.

New in version 3.0.0.

Notes

Experimental

Examples

>>> scoreAndLabels = [([0.0, 1.0], [0.0, 2.0]), ([0.0, 2.0], [0.0, 1.0]),
...     ([], [0.0]), ([2.0], [2.0]), ([2.0, 0.0], [2.0, 0.0]),
...     ([0.0, 1.0, 2.0], [0.0, 1.0]), ([1.0], [1.0, 2.0])]
>>> dataset = spark.createDataFrame(scoreAndLabels, ["prediction", "label"])
...
>>> evaluator = MultilabelClassificationEvaluator()
>>> evaluator.setPredictionCol("prediction")
MultilabelClassificationEvaluator...
>>> evaluator.evaluate(dataset)
0.63...
>>> evaluator.evaluate(dataset, {evaluator.metricName: "accuracy"})
0.54...
>>> mlce_path = temp_path + "/mlce"
>>> evaluator.save(mlce_path)
>>> evaluator2 = MultilabelClassificationEvaluator.load(mlce_path)
>>> str(evaluator2.getPredictionCol())
'prediction'

Methods

`clear`(param)	Clears a param from the param map if it has been explicitly set.
`copy`([extra])	Creates a copy of this instance with the same uid and some extra params.
`evaluate`(dataset[, params])	Evaluates the output with optional parameters.
`explainParam`(param)	Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.
`explainParams`()	Returns the documentation of all params with their optionally default values and user-supplied values.
`extractParamMap`([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 < user-supplied values < extra.
`getLabelCol`()	Gets the value of labelCol or its default value.
`getMetricLabel`()	Gets the value of metricLabel or its default value.
`getMetricName`()	Gets the value of metricName or its default value.
`getOrDefault`(param)	Gets the value of a param in the user-supplied param map or its default value.
`getParam`(paramName)	Gets a param by its name.
`getPredictionCol`()	Gets the value of predictionCol or its default value.
`hasDefault`(param)	Checks whether a param has a default value.
`hasParam`(paramName)	Tests whether this instance contains a param with a given (string) name.
`isDefined`(param)	Checks whether a param is explicitly set by user or has a default value.
`isLargerBetter`()	Indicates whether the metric returned by `evaluate()` should be maximized (True, default) or minimized (False).
`isSet`(param)	Checks whether a param is explicitly set by user.
`load`(path)	Reads an ML instance from the input path, a shortcut of read().load(path).
`read`()	Returns an MLReader instance for this class.
`save`(path)	Save this ML instance to the given path, a shortcut of 'write().save(path)'.
`set`(param, value)	Sets a parameter in the embedded param map.
`setLabelCol`(value)	Sets the value of `labelCol`.
`setMetricLabel`(value)	Sets the value of `metricLabel`.
`setMetricName`(value)	Sets the value of `metricName`.
`setParams`(self, \*[, predictionCol, ...])	Sets params for multilabel classification evaluator.
`setPredictionCol`(value)	Sets the value of `predictionCol`.
`write`()	Returns an MLWriter instance for this ML instance.

Attributes

`labelCol`
`metricLabel`
`metricName`
`params`	Returns all params ordered by name.
`predictionCol`

Methods Documentation

clear(param)#: Clears a param from the param map if it has been explicitly set.

copy(extra=None)#

Creates a copy of this instance with the same uid and some extra params. This implementation first calls Params.copy and then make a copy of the companion Java pipeline component with extra params. So both the Python wrapper and the Java pipeline component get copied.

Parameters

extradict, optional: Extra parameters to copy to the new instance

Returns

JavaParams: Copy of this instance

evaluate(dataset, params=None)#

Evaluates the output with optional parameters.

New in version 1.4.0.

Parameters

datasetpyspark.sql.DataFrame: a dataset that contains labels/observations and predictions
paramsdict, optional: an optional param map that overrides embedded params

Returns

float: metric

explainParam(param)#: Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

explainParams()#: Returns the documentation of all params with their optionally default values and user-supplied values.

extractParamMap(extra=None)#

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 < user-supplied values < extra.

Parameters

extradict, optional: extra param values

Returns

dict: merged param map

getLabelCol()#: Gets the value of labelCol or its default value.

getMetricLabel()[source]#: Gets the value of metricLabel or its default value.

New in version 3.0.0.

getMetricName()[source]#: Gets the value of metricName or its default value.

New in version 3.0.0.

getOrDefault(param)#: Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.

getParam(paramName)#: Gets a param by its name.

getPredictionCol()#: Gets the value of predictionCol or its default value.

hasDefault(param)#: Checks whether a param has a default value.

hasParam(paramName)#: Tests whether this instance contains a param with a given (string) name.

isDefined(param)#: Checks whether a param is explicitly set by user or has a default value.

isLargerBetter()#: 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.

New in version 1.5.0.

isSet(param)#: Checks whether a param is explicitly set by user.

classmethod load(path)#: Reads an ML instance from the input path, a shortcut of read().load(path).

classmethod read()#: Returns an MLReader instance for this class.

save(path)#: Save this ML instance to the given path, a shortcut of ‘write().save(path)’.

set(param, value)#: Sets a parameter in the embedded param map.

setLabelCol(value)[source]#: Sets the value of labelCol.

New in version 3.0.0.

setMetricLabel(value)[source]#: Sets the value of metricLabel.

New in version 3.0.0.

setMetricName(value)[source]#: Sets the value of metricName.

New in version 3.0.0.

setParams(self, \*, predictionCol="prediction", labelCol="label", metricName="f1Measure", metricLabel=0.0)[source]#: Sets params for multilabel classification evaluator.

New in version 3.0.0.

setPredictionCol(value)[source]#: Sets the value of predictionCol.

New in version 3.0.0.

write()#: Returns an MLWriter instance for this ML instance.

Attributes Documentation

labelCol = Param(parent='undefined', name='labelCol', doc='label column name.')#

metricLabel = Param(parent='undefined', name='metricLabel', doc='The class whose metric will be computed in precisionByLabel|recallByLabel|f1MeasureByLabel. Must be >= 0. The default value is 0.')#

metricName = Param(parent='undefined', name='metricName', doc='metric name in evaluation (subsetAccuracy|accuracy|hammingLoss|precision|recall|f1Measure|precisionByLabel|recallByLabel|f1MeasureByLabel|microPrecision|microRecall|microF1Measure)')#

params#: Returns all params ordered by name. The default implementation uses dir() to get all attributes of type Param.

predictionCol = Param(parent='undefined', name='predictionCol', doc='prediction column name.')#

uid#: A unique id for the object.