org.apache.spark.ml.param

Class ParamMap

Object

org.apache.spark.ml.param.ParamMap

All Implemented Interfaces:

java.io.Serializable

public class ParamMap
extends Object
implements scala.Serializable

:: AlphaComponent :: A param to value map.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParamMap() Creates an empty param map.
ParamMap(scala.collection.mutable.Map<Param<Object>,Object> map)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	apply(Param<T> param) Gets the value of the input param or its default value if it does not exist.
boolean	contains(Param<?> param) Checks whether a parameter is explicitly specified.
ParamMap	copy() Make a copy of this param map.
static ParamMap	empty() Returns an empty param map.
ParamMap	filter(Params parent) Filters this param map for the given parent.
<T> scala.Option<T>	get(Param<T> param) Optionally returns the value associated with a param or its default.
<T> ParamMap	put(Param<T> param, T value) Puts a (param, value) pair (overwrites if the input param exists).
ParamMap	put(ParamPair<?>... paramPairs) Puts a list of param pairs (overwrites if the input params exists).
ParamMap	put(scala.collection.Seq<ParamPair<?>> paramPairs) Puts a list of param pairs (overwrites if the input params exists).
scala.collection.Seq<ParamPair<?>>	toSeq() Converts this param map to a sequence of param pairs.
String	toString()

Methods inherited from class Object

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

Constructor Detail

ParamMap

public ParamMap(scala.collection.mutable.Map<Param<Object>,Object> map)

ParamMap

public ParamMap()

Creates an empty param map.

Method Detail

empty

public static ParamMap empty()

Returns an empty param map.

put

public ParamMap put(ParamPair<?>... paramPairs)

Puts a list of param pairs (overwrites if the input params exists).

put

public <T> ParamMap put(Param<T> param,
               T value)

Puts a (param, value) pair (overwrites if the input param exists).

put

public ParamMap put(scala.collection.Seq<ParamPair<?>> paramPairs)

Puts a list of param pairs (overwrites if the input params exists).

get

public <T> scala.Option<T> get(Param<T> param)

Optionally returns the value associated with a param or its default.

apply

public <T> T apply(Param<T> param)

Gets the value of the input param or its default value if it does not exist. Raises a NoSuchElementException if there is no value associated with the input param.

contains

public boolean contains(Param<?> param)

Checks whether a parameter is explicitly specified.

filter

public ParamMap filter(Params parent)

Filters this param map for the given parent.

copy

public ParamMap copy()

Make a copy of this param map.

toString

public String toString()

Overrides:

toString in class Object

toSeq

public scala.collection.Seq<ParamPair<?>> toSeq()

Converts this param map to a sequence of param pairs.