Trait

org.apache.spark.ml.param

Params

Related Doc: package param

Permalink

trait Params extends Identifiable with Serializable

Developer API

Trait for components that take parameters. This also provides an internal param map to store parameter values attached to the instance.

Annotations
@DeveloperApi()
Source
params.scala
Linear Supertypes
Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
AFTSurvivalRegression, AFTSurvivalRegressionModel, ALS, ALSModel, Binarizer, BinaryClassificationEvaluator, BisectingKMeans, BisectingKMeansModel, BucketedRandomProjectionLSH, Bucketizer, ChiSqSelector, ChiSqSelectorModel, ClassificationModel, Classifier, ClusteringEvaluator, CountVectorizer, CountVectorizerModel, CrossValidator, CrossValidatorModel, DCT, DecisionTreeClassificationModel, DecisionTreeClassifier, DecisionTreeRegressionModel, DecisionTreeRegressor, DistributedLDAModel, ElementwiseProduct, Estimator, Evaluator, FPGrowth, FPGrowthModel, FeatureHasher, GBTClassificationModel, GBTClassifier, GBTRegressionModel, GBTRegressor, GaussianMixture, GaussianMixtureModel, GeneralizedLinearRegressionModel, HasAggregationDepth, HasCheckpointInterval, HasCollectSubModels, HasDistanceMeasure, HasElasticNetParam, HasFeaturesCol, HasFitIntercept, HasHandleInvalid, HasInputCol, HasInputCols, HasLabelCol, HasLoss, HasMaxIter, HasOutputCol, HasOutputCols, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasRegParam, HasSeed, HasSolver, HasStandardization, HasStepSize, HasThreshold, HasThresholds, HasTol, HasValidationIndicatorCol, HasVarianceCol, HasWeightCol, HashingTF, IDF, IDFModel, Imputer, ImputerModel, IndexToString, Interaction, IsotonicRegression, IsotonicRegressionModel, JavaParams, KMeans, KMeansModel, LDA, LDAModel, LinearRegressionModel, LinearSVC, LinearSVCModel, LocalLDAModel, LogisticRegression, LogisticRegressionModel, MaxAbsScaler, MaxAbsScalerModel, MinHashLSH, MinMaxScaler, MinMaxScalerModel, Model, MulticlassClassificationEvaluator, MultilayerPerceptronClassificationModel, MultilayerPerceptronClassifier, NGram, NaiveBayes, NaiveBayesModel, Normalizer, OneHotEncoder, OneHotEncoderEstimator, OneHotEncoderModel, OneVsRest, OneVsRestModel, PCA, PCAModel, Pipeline, PipelineModel, PipelineStage, PolynomialExpansion, PredictionModel, Predictor, PrefixSpan, ProbabilisticClassificationModel, ProbabilisticClassifier, QuantileDiscretizer, RFormula, RFormulaModel, RandomForestClassificationModel, RandomForestClassifier, RandomForestRegressionModel, RandomForestRegressor, RegexTokenizer, RegressionEvaluator, RegressionModel, SQLTransformer, StandardScaler, StandardScalerModel, StopWordsRemover, StringIndexer, StringIndexerModel, Tokenizer, TrainValidationSplit, TrainValidationSplitModel, Transformer, UnaryTransformer, VectorAssembler, VectorIndexer, VectorIndexerModel, VectorSizeHint, VectorSlicer, Word2Vec, Word2VecModel
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Params
  2. Serializable
  3. Serializable
  4. Identifiable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params

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

  2. abstract 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
    Identifiable

Concrete 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

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

    Permalink
    Definition Classes
    AnyRef → Any

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. final def clear(param: Param[_]): Params.this.type

    Permalink

    Clears the user-supplied value for the input param.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

  13. def explainParams(): String

    Permalink

    Explains all params of this instance.

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

  14. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

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

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

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

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

    Permalink

    Gets a param by its name.

  22. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

  23. def hasParam(paramName: String): Boolean

    Permalink

    Tests whether this instance contains a param with a given name.

  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def isDefined(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set or has a default value.

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink

    Checks whether a param is explicitly set.

  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  32. final def set(paramPair: ParamPair[_]): Params.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected

  33. final def set(param: String, value: Any): Params.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

  34. final def set[T](param: Param[T], value: T): Params.this.type

    Permalink

    Sets a parameter in the embedded param map.

  35. final def setDefault(paramPairs: ParamPair[_]*): Params.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

  36. final def setDefault[T](param: Param[T], value: T): Params.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

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

    Permalink
    Definition Classes
    AnyRef

  38. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  39. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )