org.apache.spark.ml.tuning

Class ParamGridBuilder

Object

org.apache.spark.ml.tuning.ParamGridBuilder

public class ParamGridBuilder
extends Object

Builder for a param grid used in grid search-based model selection.

Constructor Summary

Constructors

Constructor and Description
ParamGridBuilder()

Method Summary

Modifier and Type	Method and Description
ParamGridBuilder	addGrid(BooleanParam param) Adds a boolean param with true and false.
ParamGridBuilder	addGrid(DoubleParam param, double[] values) Adds a double param with multiple values.
ParamGridBuilder	addGrid(FloatParam param, float[] values) Adds a float param with multiple values.
ParamGridBuilder	addGrid(IntParam param, int[] values) Adds an int param with multiple values.
ParamGridBuilder	addGrid(LongParam param, long[] values) Adds a long param with multiple values.
<T> ParamGridBuilder	addGrid(Param<T> param, scala.collection.Iterable<T> values) Adds a param with multiple values (overwrites if the input param exists).
ParamGridBuilder	baseOn(ParamMap paramMap) Sets the given parameters in this grid to fixed values.
ParamGridBuilder	baseOn(ParamPair<?>... paramPairs) Sets the given parameters in this grid to fixed values.
ParamGridBuilder	baseOn(scala.collection.Seq<ParamPair<?>> paramPairs) Sets the given parameters in this grid to fixed values.
ParamMap[]	build() Builds and returns all combinations of parameters specified by the param grid.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParamGridBuilder

public ParamGridBuilder()

Method Detail

addGrid

public <T> ParamGridBuilder addGrid(Param<T> param,
                                    scala.collection.Iterable<T> values)

Adds a param with multiple values (overwrites if the input param exists).

Parameters:

param - (undocumented)

values - (undocumented)

Returns:

(undocumented)

addGrid

public ParamGridBuilder addGrid(DoubleParam param,
                                double[] values)

Adds a double param with multiple values.

Parameters:

param - (undocumented)

values - (undocumented)

Returns:

(undocumented)

addGrid

public ParamGridBuilder addGrid(IntParam param,
                                int[] values)

Adds an int param with multiple values.

Parameters:

param - (undocumented)

values - (undocumented)

Returns:

(undocumented)

addGrid

public ParamGridBuilder addGrid(FloatParam param,
                                float[] values)

Adds a float param with multiple values.

Parameters:

param - (undocumented)

values - (undocumented)

Returns:

(undocumented)

addGrid

public ParamGridBuilder addGrid(LongParam param,
                                long[] values)

Adds a long param with multiple values.

Parameters:

param - (undocumented)

values - (undocumented)

Returns:

(undocumented)

addGrid

public ParamGridBuilder addGrid(BooleanParam param)

Adds a boolean param with true and false.

Parameters:

param - (undocumented)

Returns:

(undocumented)

baseOn

public ParamGridBuilder baseOn(ParamPair<?>... paramPairs)

Sets the given parameters in this grid to fixed values.

Parameters:

paramPairs - (undocumented)

Returns:

(undocumented)

baseOn

public ParamGridBuilder baseOn(ParamMap paramMap)

Sets the given parameters in this grid to fixed values.

Parameters:

paramMap - (undocumented)

Returns:

(undocumented)

baseOn

public ParamGridBuilder baseOn(scala.collection.Seq<ParamPair<?>> paramPairs)

Sets the given parameters in this grid to fixed values.

Parameters:

paramPairs - (undocumented)

Returns:

(undocumented)

build

public ParamMap[] build()

Builds and returns all combinations of parameters specified by the param grid.

Returns:

(undocumented)