Class/Object

org.apache.spark.ml.classification

LinearSVCModel

Related Docs: object LinearSVCModel | package classification

Permalink

class LinearSVCModel extends ClassificationModel[Vector, LinearSVCModel] with LinearSVCParams with MLWritable

:: Experimental :: Linear SVM Model trained by LinearSVC

Annotations
@Since( "2.2.0" ) @Experimental()
Source
LinearSVC.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. LinearSVCModel
  2. MLWritable
  3. LinearSVCParams
  4. HasThreshold
  5. HasAggregationDepth
  6. HasWeightCol
  7. HasStandardization
  8. HasTol
  9. HasFitIntercept
  10. HasMaxIter
  11. HasRegParam
  12. ClassificationModel
  13. ClassifierParams
  14. HasRawPredictionCol
  15. PredictionModel
  16. PredictorParams
  17. HasPredictionCol
  18. HasFeaturesCol
  19. HasLabelCol
  20. Model
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final val aggregationDepth: IntParam

    Permalink

    Param for suggested depth for treeAggregate (>= 2).

    Param for suggested depth for treeAggregate (>= 2).

    Definition Classes
    HasAggregationDepth
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. final def clear(param: Param[_]): LinearSVCModel.this.type

    Permalink

    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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val coefficients: Vector

    Permalink
    Annotations
    @Since( "2.2.0" )
  10. def copy(extra: ParamMap): LinearSVCModel

    Permalink

    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
    LinearSVCModelModelTransformerPipelineStageParams
    Annotations
    @Since( "2.2.0" )
  11. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Permalink

    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
  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink

    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
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String

    Permalink

    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
  16. def explainParams(): String

    Permalink

    Explains all params of this instance.

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

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

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink

    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
  19. final val featuresCol: Param[String]

    Permalink

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  20. def featuresDataType: DataType

    Permalink

    Returns the SQL DataType corresponding to the FeaturesType type parameter.

    Returns the SQL DataType corresponding to the FeaturesType type parameter.

    This is used by validateAndTransformSchema(). This workaround is needed since SQL has different APIs for Scala and Java.

    The default value is VectorUDT, but it may be overridden if FeaturesType is not Vector.

    Attributes
    protected
    Definition Classes
    PredictionModel
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final val fitIntercept: BooleanParam

    Permalink

    Param for whether to fit an intercept term.

    Param for whether to fit an intercept term.

    Definition Classes
    HasFitIntercept
  23. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  24. final def getAggregationDepth: Int

    Permalink

    Definition Classes
    HasAggregationDepth
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  27. final def getFeaturesCol: String

    Permalink

    Definition Classes
    HasFeaturesCol
  28. final def getFitIntercept: Boolean

    Permalink

    Definition Classes
    HasFitIntercept
  29. final def getLabelCol: String

    Permalink

    Definition Classes
    HasLabelCol
  30. final def getMaxIter: Int

    Permalink

    Definition Classes
    HasMaxIter
  31. final def getOrDefault[T](param: Param[T]): T

    Permalink

    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
  32. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  33. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  34. final def getRawPredictionCol: String

    Permalink

    Definition Classes
    HasRawPredictionCol
  35. final def getRegParam: Double

    Permalink

    Definition Classes
    HasRegParam
  36. final def getStandardization: Boolean

    Permalink

    Definition Classes
    HasStandardization
  37. def getThreshold: Double

    Permalink

    Definition Classes
    HasThreshold
  38. final def getTol: Double

    Permalink

    Definition Classes
    HasTol
  39. final def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  40. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes
    Params
  41. def hasParam(paramName: String): Boolean

    Permalink

    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
  42. def hasParent: Boolean

    Permalink

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  43. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  44. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. val intercept: Double

    Permalink
    Annotations
    @Since( "2.2.0" )
  47. final def isDefined(param: Param[_]): Boolean

    Permalink

    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
  48. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  49. final def isSet(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  50. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. final val labelCol: Param[String]

    Permalink

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  52. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. final val maxIter: IntParam

    Permalink

    Param for maximum number of iterations (>= 0).

    Param for maximum number of iterations (>= 0).

    Definition Classes
    HasMaxIter
  65. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  66. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  67. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  68. val numClasses: Int

    Permalink

    Number of classes (values which the label can take).

    Number of classes (values which the label can take).

    Definition Classes
    LinearSVCModelClassificationModel
    Annotations
    @Since( "2.2.0" )
  69. val numFeatures: Int

    Permalink

    Returns the number of features the model was trained on.

    Returns the number of features the model was trained on. If unknown, returns -1

    Definition Classes
    LinearSVCModelPredictionModel
    Annotations
    @Since( "2.2.0" )
  70. lazy val params: Array[Param[_]]

    Permalink

    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.

  71. var parent: Estimator[LinearSVCModel]

    Permalink

    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.

  72. def predict(features: Vector): Double

    Permalink

    Predict label for the given features.

    Predict label for the given features. This internal method is used to implement transform() and output predictionCol.

    This default implementation for classification predicts the index of the maximum value from predictRaw().

    Attributes
    protected
    Definition Classes
    LinearSVCModelClassificationModelPredictionModel
  73. def predictRaw(features: Vector): Vector

    Permalink

    Raw prediction for each possible label.

    Raw prediction for each possible label. The meaning of a "raw" prediction may vary between algorithms, but it intuitively gives a measure of confidence in each possible label (where larger = more confident). This internal method is used to implement transform() and output rawPredictionCol.

    returns

    vector where element i is the raw prediction for label i. This raw prediction may be any real number, where a larger value indicates greater confidence for that label.

    Attributes
    protected
    Definition Classes
    LinearSVCModelClassificationModel
  74. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  75. def raw2prediction(rawPrediction: Vector): Double

    Permalink

    Given a vector of raw predictions, select the predicted label.

    Given a vector of raw predictions, select the predicted label. This may be overridden to support thresholds which favor particular labels.

    returns

    predicted label

    Attributes
    protected
    Definition Classes
    LinearSVCModelClassificationModel
  76. final val rawPredictionCol: Param[String]

    Permalink

    Param for raw prediction (a.k.a.

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

    Definition Classes
    HasRawPredictionCol
  77. final val regParam: DoubleParam

    Permalink

    Param for regularization parameter (>= 0).

    Param for regularization parameter (>= 0).

    Definition Classes
    HasRegParam
  78. def save(path: String): Unit

    Permalink

    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( ... )
  79. final def set(paramPair: ParamPair[_]): LinearSVCModel.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  80. final def set(param: String, value: Any): LinearSVCModel.this.type

    Permalink

    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
  81. final def set[T](param: Param[T], value: T): LinearSVCModel.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  82. final def setDefault(paramPairs: ParamPair[_]*): LinearSVCModel.this.type

    Permalink

    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
  83. final def setDefault[T](param: Param[T], value: T): LinearSVCModel.this.type

    Permalink

    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
  84. def setFeaturesCol(value: String): LinearSVCModel

    Permalink

    Definition Classes
    PredictionModel
  85. def setParent(parent: Estimator[LinearSVCModel]): LinearSVCModel

    Permalink

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  86. def setPredictionCol(value: String): LinearSVCModel

    Permalink

    Definition Classes
    PredictionModel
  87. def setRawPredictionCol(value: String): LinearSVCModel

    Permalink

    Definition Classes
    ClassificationModel
  88. def setThreshold(value: Double): LinearSVCModel.this.type

    Permalink
    Annotations
    @Since( "2.2.0" )
  89. def setWeightCol(value: Double): LinearSVCModel.this.type

    Permalink
    Annotations
    @Since( "2.2.0" )
  90. final val standardization: BooleanParam

    Permalink

    Param for whether to standardize the training features before fitting the model.

    Param for whether to standardize the training features before fitting the model.

    Definition Classes
    HasStandardization
  91. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  92. final val threshold: DoubleParam

    Permalink

    Param for threshold in binary classification prediction.

    Param for threshold in binary classification prediction. For LinearSVC, this threshold is applied to the rawPrediction, rather than a probability. This threshold can be any real number, where Inf will make all predictions 0.0 and -Inf will make all predictions 1.0. Default: 0.0

    Definition Classes
    LinearSVCParams → HasThreshold
  93. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  94. final val tol: DoubleParam

    Permalink

    Param for the convergence tolerance for iterative algorithms (>= 0).

    Param for the convergence tolerance for iterative algorithms (>= 0).

    Definition Classes
    HasTol
  95. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters:

    Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters:

    dataset

    input dataset

    returns

    transformed dataset

    Definition Classes
    ClassificationModelPredictionModelTransformer
  96. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink

    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" )
  97. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink

    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()
  98. def transformImpl(dataset: Dataset[_]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    PredictionModel
  99. def transformSchema(schema: StructType): StructType

    Permalink

    :: 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
    PredictionModelPipelineStage
  100. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink

    :: 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()
  101. val uid: String

    Permalink

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    LinearSVCModelIdentifiable
    Annotations
    @Since( "2.2.0" )
  102. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink

    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
  103. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  104. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  105. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final val weightCol: Param[String]

    Permalink

    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
  107. def write: MLWriter

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    LinearSVCModelMLWritable
    Annotations
    @Since( "2.2.0" )

Inherited from MLWritable

Inherited from LinearSVCParams

Inherited from HasThreshold

Inherited from HasAggregationDepth

Inherited from HasWeightCol

Inherited from HasStandardization

Inherited from HasTol

Inherited from HasFitIntercept

Inherited from HasMaxIter

Inherited from HasRegParam

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Model[LinearSVCModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

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

Members

Parameter setters

Parameter getters

(expert-only) Parameters

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

(expert-only) Parameter getters