Class

org.apache.spark.ml.param

Param

Related Doc: package param

Permalink

class Param[T] extends 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.

T: param value type

Annotations: @DeveloperApi()

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Known Subclasses

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

Ordering

Alphabetic
By inheritance

Inherited

Param
Serializable
Serializable
AnyRef
Any

Hide All
Show all

Visibility

Public
All

Instance Constructors

new Param(parent: Identifiable, name: String, doc: String)
new Param(parent: String, name: String, doc: String)
new Param(parent: Identifiable, name: String, doc: String, isValid: (T) ⇒ Boolean)
new Param(parent: String, name: String, doc: String, isValid: (T) ⇒ Boolean)

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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def ->(value: T): ParamPair[T]

Creates a param pair with the given value (for Scala).
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val doc: String

documentation
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def equals(obj: Any): Boolean

Definition Classes
Param → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def hashCode(): Int

Definition Classes
Param → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isValid: (T) ⇒ Boolean

optional validation method which indicates if a value is valid.
optional validation method which indicates if a value is valid. See ParamValidators for factory methods for common validation functions.
val name: String

param name
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val parent: String

parent object
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toString(): String

Definition Classes
Param → AnyRef → Any
def w(value: T): ParamPair[T]

Creates a param pair with the given value (for Java).
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Members