org.apache.spark.ml.param

Class Param<T>

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

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

public class Param<T>
extends java.lang.Object
implements scala.Serializable

:: DeveloperApi :: 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 and Description
Param(Identifiable parent, java.lang.String name, java.lang.String doc)
Param(Identifiable parent, java.lang.String name, java.lang.String doc, scala.Function1<T,java.lang.Object> isValid)
Param(java.lang.String parent, java.lang.String name, java.lang.String doc)
Param(java.lang.String parent, java.lang.String name, java.lang.String doc, scala.Function1<T,java.lang.Object> isValid)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Param

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

Param

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

Param

public Param(java.lang.String parent,
     java.lang.String name,
     java.lang.String doc)

Param

public Param(Identifiable parent,
     java.lang.String name,
     java.lang.String doc)

Method Detail

parent

public java.lang.String parent()

name

public java.lang.String name()

doc

public java.lang.String doc()

isValid

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

w

public ParamPair<T> w(T value)

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

jsonEncode

public java.lang.String jsonEncode(T value)

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

jsonDecode

public T jsonDecode(java.lang.String json)

Decodes a param value from JSON.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object