Params (Spark 3.5.5 JavaDoc) (original) (raw)

Modifier and Type

Method and Description

[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

Clears the user-supplied value for the input param.

[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-)([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)

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

<T extends [Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")> T

[copyValues](../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-)(T to,[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)

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

<T extends [Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")> T

[defaultCopy](../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-)([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)

Default implementation of copy with extra params.

[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param")

[defaultParamMap](../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--)()

Internal param map for default values.

String

[explainParam](../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

Explains a param.

String

[explainParams](../../../../../org/apache/spark/ml/param/Params.html#explainParams--)()

Explains all params of this instance.

[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param")

[extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--)()

extractParamMap with no extra values.

[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param")

[extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-)([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") 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.

<T> scala.Option<T>

[get](../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param)

Optionally returns the user-supplied value of a param.

<T> scala.Option<T>

[getDefault](../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param)

Gets the default value of a parameter.

<T> T

[getOrDefault](../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param)

Gets the value of a param in the embedded param map or its default value.

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<Object>

[getParam](../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-)(String paramName)

Gets a param by its name.

<T> boolean

[hasDefault](../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param)

Tests whether the input param has a default value set.

boolean

[hasParam](../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-)(String paramName)

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

boolean

[isDefined](../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

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

boolean

[isSet](../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

Checks whether a param is explicitly set.

void

[onParamChange](../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param")

[paramMap](../../../../../org/apache/spark/ml/param/Params.html#paramMap--)()

Internal param map for user-supplied values.

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?>[]

[params](../../../../../org/apache/spark/ml/param/Params.html#params--)()

Returns all params sorted by their names.

<T> [Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param, T value)

Sets a parameter in the embedded param map.

[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-)([ParamPair](../../../../../org/apache/spark/ml/param/ParamPair.html "class in org.apache.spark.ml.param")<?> paramPair)

Sets a parameter in the embedded param map.

[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[set](../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-)(String param, Object value)

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

<T> [Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<T> param, T value)

Sets a default value for a param.

[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")

[setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-)(scala.collection.Seq<[ParamPair](../../../../../org/apache/spark/ml/param/ParamPair.html "class in org.apache.spark.ml.param")<?>> paramPairs)

Sets default values for a list of params.

void

[shouldOwn](../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-)([Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<?> param)

Validates that the input param belongs to this instance.