Packages

final class OneVsRestModel extends Model[OneVsRestModel] with OneVsRestParams with MLWritable

Model produced 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.

Annotations
@Since( "1.4.0" )
Source
OneVsRest.scala
Linear Supertypes
MLWritable, OneVsRestParams, HasWeightCol, ClassifierTypeTrait, ClassifierParams, HasRawPredictionCol, PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Model[OneVsRestModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. OneVsRestModel
  2. MLWritable
  3. OneVsRestParams
  4. HasWeightCol
  5. ClassifierTypeTrait
  6. ClassifierParams
  7. HasRawPredictionCol
  8. PredictorParams
  9. HasPredictionCol
  10. HasFeaturesCol
  11. HasLabelCol
  12. Model
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

  1. val classifier: Param[ClassifierType]

    param for the base binary classifier that we reduce multiclass classification into.

    param for the base binary classifier that we reduce multiclass classification into. The base classifier input and output columns are ignored in favor of the ones specified in OneVsRest.

    Definition Classes
    OneVsRestParams
  2. final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  3. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  4. final val predictionCol: Param[String]

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  5. final val rawPredictionCol: Param[String]

    Param for raw prediction (a.k.a.

    Param for raw prediction (a.k.a. confidence) column name.

    Definition Classes
    HasRawPredictionCol
  6. final val weightCol: Param[String]

    Param for weight column name.

    Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.

    Definition Classes
    HasWeightCol

Members

  1. type ClassifierType = Classifier[F, E, M] forSome {type F, type M <: ClassificationModel[F, M], type E <: Classifier[F, E, M]}
    Definition Classes
    ClassifierTypeTrait
  1. final def clear(param: Param[_]): OneVsRestModel.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  2. def copy(extra: ParamMap): OneVsRestModel

    Creates a copy of this instance with the same UID and some extra params.

    Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

    Definition Classes
    OneVsRestModelModelTransformerPipelineStageParams
    Annotations
    @Since( "1.4.1" )
  3. 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
  4. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  5. final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  6. 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
  7. 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
  8. 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
  9. 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
  10. def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  11. 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
  12. 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
  13. def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  14. 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
  15. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  16. val models: Array[_ <: ClassificationModel[_, _]]
    Annotations
    @Since( "1.4.0" )
  17. val numClasses: Int
    Annotations
    @Since( "2.4.0" )
  18. val numFeatures: Int
    Annotations
    @Since( "2.4.0" )
  19. 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.

  20. var parent: Estimator[OneVsRestModel]

    The parent estimator that produced this model.

    The parent estimator that produced this model.

    Definition Classes
    Model
    Note

    For ensembles' component Models, this value can be null.

  21. def save(path: String): Unit

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  22. final def set[T](param: Param[T], value: T): OneVsRestModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  23. def setParent(parent: Estimator[OneVsRestModel]): OneVsRestModel

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  24. def toString(): String
    Definition Classes
    OneVsRestModelIdentifiable → AnyRef → Any
    Annotations
    @Since( "3.0.0" )
  25. def transform(dataset: Dataset[_]): DataFrame

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes
    OneVsRestModelTransformer
    Annotations
    @Since( "2.0.0" )
  26. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  27. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    firstParamPair

    the first param pair, overwrite embedded params

    otherParamPairs

    other param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. def transformSchema(schema: StructType): StructType

    Check transform validity and derive the output schema from the input schema.

    Check transform validity and derive the output schema from the input schema.

    We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

    Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

    Definition Classes
    OneVsRestModelPipelineStage
    Annotations
    @Since( "1.4.0" )
  29. 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
    OneVsRestModelIdentifiable
    Annotations
    @Since( "1.4.0" )
  30. def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    OneVsRestModelMLWritable
    Annotations
    @Since( "2.0.0" )

Parameter setters

  1. def setFeaturesCol(value: String): OneVsRestModel.this.type

    Annotations
    @Since( "2.1.0" )
  2. def setPredictionCol(value: String): OneVsRestModel.this.type

    Annotations
    @Since( "2.1.0" )
  3. def setRawPredictionCol(value: String): OneVsRestModel.this.type

    Annotations
    @Since( "2.4.0" )

Parameter getters

  1. def getClassifier: ClassifierType

    Definition Classes
    OneVsRestParams
  2. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  3. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  4. final def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  5. final def getRawPredictionCol: String

    Definition Classes
    HasRawPredictionCol
  6. final def getWeightCol: String

    Definition Classes
    HasWeightCol