Package org.apache.spark.ml.param

Class Param<T>

Object

org.apache.spark.ml.param.Param<T>

Type Parameters:

T - param value type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BooleanParam, DoubleArrayArrayParam, DoubleArrayParam, DoubleParam, FloatParam, IntArrayParam, IntParam, LongParam, StringArrayParam

public class Param<T>
extends Object
implements Serializable

A param with self-contained documentation and optionally default value. Primitive-typed param should use the specialized versions, which are more friendly to Java users.

param: parent parent object param: name param name param: doc documentation param: isValid optional validation method which indicates if a value is valid. See ParamValidators for factory methods for common validation functions.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Param(String parent, String name, String doc)
Param(String parent, String name, String doc, Class<T> dataClass)
Param(String parent, String name, String doc, scala.Function1<T,Object> isValid)
Param(String parent, String name, String doc, scala.Function1<T,Object> isValid, Class<T> dataClass)
Param(Identifiable parent, String name, String doc)
Param(Identifiable parent, String name, String doc, scala.Function1<T,Object> isValid)

Method Summary

Modifier and Type	Method	Description
Class<T>	dataClass()
String	doc()
final boolean	equals(Object obj)
final int	hashCode()
scala.Function1<T,Object>	isValid()
T	jsonDecode(String json)	Decodes a param value from JSON.
String	jsonEncode(T value)	Encodes a param value into JSON, which can be decoded by `jsonDecode()`.
String	name()
String	parent()
final String	toString()
ParamPair<T>	w(T value)	Creates a param pair with the given value (for Java).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Param

public Param(String parent,
 String name,
 String doc,
 scala.Function1<T,Object> isValid,
 Class<T> dataClass)

Param

public Param(String parent,
 String name,
 String doc,
 scala.Function1<T,Object> isValid)

Param

public Param(Identifiable parent,
 String name,
 String doc,
 scala.Function1<T,Object> isValid)

Param

public Param(String parent,
 String name,
 String doc)

Param

public Param(String parent,
 String name,
 String doc,
 Class<T> dataClass)

Param

public Param(Identifiable parent,
 String name,
 String doc)

Method Details

parent

public String parent()

name

public String name()

doc

public String doc()

isValid

public scala.Function1<T,Object> isValid()

dataClass

public Class<T> dataClass()

w

public ParamPair<T> w(T value)

Creates a param pair with the given value (for Java).

jsonEncode

public String jsonEncode(T value)

Encodes a param value into JSON, which can be decoded by `jsonDecode()`.

jsonDecode

public T jsonDecode(String json)

Decodes a param value from JSON.

toString

public final String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object