Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def $[T](param: Param[T]): T

   An alias for getOrDefault().

   An alias for getOrDefault().

   Attributes

   protected

   Definition Classes

   Params

4.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  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

7.  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

8.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

9.  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

   OneVsRestModel → Model → Transformer → PipelineStage → Params

   Annotations

   @Since( "1.4.1" )

10.  def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes

    protected

    Definition Classes

    Params

11.  final def defaultCopy[T <: Params](extra: ParamMap): T

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes

    protected

    Definition Classes

    Params

12.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

13.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

14.  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

15.  def explainParams(): String

    Explains all params of this instance.

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

    Definition Classes

    Params

16.  final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes

    Params

17.  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

18.  final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes

    HasFeaturesCol

19.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

20.  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

21.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

22.  def getClassifier: ClassifierType
    Definition Classes

    OneVsRestParams

23.  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

24.  final def getFeaturesCol: String
    Definition Classes

    HasFeaturesCol

25.  final def getLabelCol: String
    Definition Classes

    HasLabelCol

26.  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

27.  def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes

    Params

28.  final def getPredictionCol: String
    Definition Classes

    HasPredictionCol

29.  final def getRawPredictionCol: String
    Definition Classes

    HasRawPredictionCol

30.  final def getWeightCol: String
    Definition Classes

    HasWeightCol

31.  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

32.  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

33.  def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes

    Model

34.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

35.  def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Attributes

    protected

    Definition Classes

    Logging

36.  def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes

    protected

    Definition Classes

    Logging

37.  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

38.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

39.  final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes

    Params

40.  def isTraceEnabled(): Boolean

    Attributes

    protected

    Definition Classes

    Logging

41.  final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes

    HasLabelCol

42.  def log: Logger

    Attributes

    protected

    Definition Classes

    Logging

43.  def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

44.  def logDebug(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

45.  def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

46.  def logError(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

47.  def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

48.  def logInfo(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

49.  def logName: String

    Attributes

    protected

    Definition Classes

    Logging

50.  def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

51.  def logTrace(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

52.  def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

53.  def logWarning(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

54.  val models: Array[_ <: ClassificationModel[_, _]]

    Annotations

    @Since( "1.4.0" )

55.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

56.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

57.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

58.  val numClasses: Int

    Annotations

    @Since( "2.4.0" )

59.  val numFeatures: Int

    Annotations

    @Since( "2.4.0" )

60.  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.

61.  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.

62.  final val predictionCol: Param[String]

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes

    HasPredictionCol

63.  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

64.  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( ... )

65.  final def set(paramPair: ParamPair[_]): OneVsRestModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

66.  final def set(param: String, value: Any): OneVsRestModel.this.type

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

67.  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

68.  final def setDefault(paramPairs: ParamPair[_]*): OneVsRestModel.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes

    protected

    Definition Classes

    Params

69.  final def setDefault[T](param: Param[T], value: T): OneVsRestModel.this.type

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes

    protected

    Definition Classes

    Params

70.  def setFeaturesCol(value: String): OneVsRestModel.this.type
    Annotations

    @Since( "2.1.0" )

71.  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

72.  def setPredictionCol(value: String): OneVsRestModel.this.type
    Annotations

    @Since( "2.1.0" )

73.  def setRawPredictionCol(value: String): OneVsRestModel.this.type
    Annotations

    @Since( "2.4.0" )

74.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

75.  def toString(): String

    Definition Classes

    Identifiable → AnyRef → Any

76.  def transform(dataset: Dataset[_]): DataFrame

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes

    OneVsRestModel → Transformer

    Annotations

    @Since( "2.0.0" )

77.  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" )

78.  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()

79.  def transformSchema(schema: StructType): StructType

    :: DeveloperApi ::

    :: DeveloperApi ::

    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

    OneVsRestModel → PipelineStage

    Annotations

    @Since( "1.4.0" )

80.  def transformSchema(schema: StructType, logging: Boolean): StructType

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes

    protected

    Definition Classes

    PipelineStage

    Annotations

    @DeveloperApi()

81.  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

    OneVsRestModel → Identifiable

    Annotations

    @Since( "1.4.0" )

82.  def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Validates and transforms the input schema with the provided param map.

    Validates and transforms the input schema with the provided param map.

    schema

    input schema

    fitting

    whether this is in fitting

    featuresDataType

    SQL DataType for FeaturesType. E.g., VectorUDT for vector features.

    returns

    output schema

    Attributes

    protected

    Definition Classes

    ClassifierParams → PredictorParams

83.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

84.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

85.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

86.  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

87.  def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes

    OneVsRestModel → MLWritable

    Annotations

    @Since( "2.0.0" )