Packages

trait Params extends Identifiable with Serializable

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

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

Abstract Value Members

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

    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

    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 clear(param: Param[_]): Params.this.type

    Clears the user-supplied value for the input param.

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

  3. def explainParams(): String

    Explains all params of this instance.

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

  4. final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

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

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

    Optionally returns the user-supplied value of a param.

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

    Gets the default value of a parameter.

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

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

    Gets a param by its name.

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

    Tests whether the input param has a default value set.

  11. def hasParam(paramName: String): Boolean

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

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

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

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

    Checks whether a param is explicitly set.

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

    Note

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

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

    Sets a parameter in the embedded param map.

  16. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any