OneVsRestModel¶

class pyspark.ml.classification.OneVsRestModel(models: List[pyspark.ml.classification.ClassificationModel])[source]¶

Model fitted by OneVsRest. This stores the models resulting from training k binary classifiers: one for each class. Each example is scored against all k models, and the model with the highest score is picked to label the example.

New in version 2.0.0.

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 a randomly generated uid and some extra params.
`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.
`getClassifier`()	Gets the value of classifier or its default value.
`getFeaturesCol`()	Gets the value of featuresCol or its default value.
`getLabelCol`()	Gets the value of labelCol 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.
`getRawPredictionCol`()	Gets the value of rawPredictionCol or its default value.
`getWeightCol`()	Gets the value of weightCol 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.
`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.
`setFeaturesCol`(value)	Sets the value of `featuresCol`.
`setPredictionCol`(value)	Sets the value of `predictionCol`.
`setRawPredictionCol`(value)	Sets the value of `rawPredictionCol`.
`transform`(dataset[, params])	Transforms the input dataset with optional parameters.
`write`()	Returns an MLWriter instance for this ML instance.

Attributes

`classifier`
`featuresCol`
`labelCol`
`params`	Returns all params ordered by name.
`predictionCol`
`rawPredictionCol`
`weightCol`

Methods Documentation

clear(param: pyspark.ml.param.Param) → None¶: Clears a param from the param map if it has been explicitly set.

copy(extra: Optional[ParamMap] = None) → OneVsRestModel[source]¶

Creates a copy of this instance with a randomly generated uid and some extra params. This creates a deep copy of the embedded paramMap, and copies the embedded and extra parameters over.

New in version 2.0.0.

Parameters

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

Returns

OneVsRestModel: Copy of this instance

explainParam(param: Union[str, pyspark.ml.param.Param]) → str¶: Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

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

extractParamMap(extra: Optional[ParamMap] = None) → 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 < user-supplied values < extra.

Parameters

extradict, optional: extra param values

Returns

dict: merged param map

getClassifier() → pyspark.ml.classification.Classifier¶: Gets the value of classifier or its default value.

New in version 2.0.0.

getFeaturesCol() → str¶: Gets the value of featuresCol or its default value.

getLabelCol() → str¶: Gets the value of labelCol or its default value.

getOrDefault(param: Union[str, pyspark.ml.param.Param[T]]) → Union[Any, T]¶: 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: str) → pyspark.ml.param.Param ¶: Gets a param by its name.

getPredictionCol() → str¶: Gets the value of predictionCol or its default value.

getRawPredictionCol() → str¶: Gets the value of rawPredictionCol or its default value.

getWeightCol() → str¶: Gets the value of weightCol or its default value.

hasDefault(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param has a default value.

hasParam(paramName: str) → bool¶: Tests whether this instance contains a param with a given (string) name.

isDefined(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user or has a default value.

isSet(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user.

classmethod load(path: str) → RL¶: Reads an ML instance from the input path, a shortcut of read().load(path).

classmethod read() → pyspark.ml.classification.OneVsRestModelReader[source]¶: Returns an MLReader instance for this class.

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

set(param: pyspark.ml.param.Param, value: Any) → None¶: Sets a parameter in the embedded param map.

setFeaturesCol(value: str) → pyspark.ml.classification.OneVsRestModel [source]¶: Sets the value of featuresCol.

setPredictionCol(value: str) → pyspark.ml.classification.OneVsRestModel [source]¶: Sets the value of predictionCol.

setRawPredictionCol(value: str) → pyspark.ml.classification.OneVsRestModel [source]¶: Sets the value of rawPredictionCol.

transform(dataset: pyspark.sql.dataframe.DataFrame, params: Optional[ParamMap] = None) → pyspark.sql.dataframe.DataFrame¶

Transforms the input dataset with optional parameters.

New in version 1.3.0.

Parameters

datasetpyspark.sql.DataFrame: input dataset
paramsdict, optional: an optional param map that overrides embedded params.

Returns

pyspark.sql.DataFrame: transformed dataset

write() → pyspark.ml.util.MLWriter [source]¶: Returns an MLWriter instance for this ML instance.

Attributes Documentation

classifier: pyspark.ml.param.Param[pyspark.ml.classification.Classifier] = Param(parent='undefined', name='classifier', doc='base binary classifier')¶

featuresCol = Param(parent='undefined', name='featuresCol', doc='features column name.')¶

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

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.')¶

rawPredictionCol = Param(parent='undefined', name='rawPredictionCol', doc='raw prediction (a.k.a. confidence) column name.')¶

weightCol = Param(parent='undefined', name='weightCol', doc='weight column name. If this is not set or empty, we treat all instance weights as 1.0.')¶

OneVsRest

FMClassifier