JavaParams

Instance Constructors

new JavaParams()

Abstract Value Members

abstract def copy(extra: ParamMap): Params

Creates a copy of this instance with the same UID and some extra params.
Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

Definition Classes
Params
abstract val uid: String

An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.

Definition Classes
Identifiable

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

An alias for getOrDefault().
An alias for getOrDefault().

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
final def clear(param: Param[_]): JavaParams.this.type

Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.

Definition Classes
Params
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.
to
the target instance, which should work with the same set of default Params as this source instance
extra
extra params to be copied to the target's paramMap
returns
the target instance with param values copied

Attributes
protected
Definition Classes
Params
final def defaultCopy[T <: Params](extra: ParamMap): T

Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String

Explains a param.
Explains a param.
param
input param, must belong to this instance.
returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value

Definition Classes
Params
def explainParams(): String

Explains all params of this instance.
Explains all params of this instance. See explainParam().

Definition Classes
Params
final def extractParamMap(): ParamMap

extractParamMap with no extra values.
extractParamMap with no extra values.

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

Definition Classes
Params
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[T](param: Param[T]): Option[T]

Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.

Definition Classes
Params
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getDefault[T](param: Param[T]): Option[T]

Gets the default value of a parameter.
Gets the default value of a parameter.

Definition Classes
Params
final def getOrDefault[T](param: Param[T]): T

Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

Definition Classes
Params
def getParam(paramName: String): Param[Any]

Gets a param by its name.
Gets a param by its name.

Definition Classes
Params
final def hasDefault[T](param: Param[T]): Boolean

Tests whether the input param has a default value set.
Tests whether the input param has a default value set.

Definition Classes
Params
def hasParam(paramName: String): Boolean

Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isDefined(param: Param[_]): Boolean

Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isSet(param: Param[_]): Boolean

Checks whether a param is explicitly set.
Checks whether a param is explicitly set.

Definition Classes
Params
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
lazy val params: Array[Param[_]]

Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

Definition Classes
Params
Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
final def set(paramPair: ParamPair[_]): JavaParams.this.type

Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): JavaParams.this.type

Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.

Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): JavaParams.this.type

Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.

Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): JavaParams.this.type

Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.
paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): JavaParams.this.type

Sets a default value for a param.
Sets a default value for a param.
param
param to set the default value. Make sure that this param is initialized before this method gets called.
value
the default value

Attributes
protected
Definition Classes
Params
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
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( ... )

Related Doc: package param

abstract class JavaParams extends Params

Instance Constructors

new JavaParams()

Abstract Value Members

abstract def copy(extra: ParamMap): Params

abstract val uid: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def clear(param: Param[_]): JavaParams.this.type

def clone(): AnyRef

def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

final def defaultCopy[T <: Params](extra: ParamMap): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explainParam(param: Param[_]): String

def explainParams(): String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

def finalize(): Unit

final def get[T](param: Param[T]): Option[T]

final def getClass(): Class[_]

final def getDefault[T](param: Param[T]): Option[T]

final def getOrDefault[T](param: Param[T]): T

def getParam(paramName: String): Param[Any]

final def hasDefault[T](param: Param[T]): Boolean

def hasParam(paramName: String): Boolean

def hashCode(): Int

final def isDefined(param: Param[_]): Boolean

final def isInstanceOf[T0]: Boolean

final def isSet(param: Param[_]): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

lazy val params: Array[Param[_]]

final def set(paramPair: ParamPair[_]): JavaParams.this.type

final def set(param: String, value: Any): JavaParams.this.type

final def set[T](param: Param[T], value: T): JavaParams.this.type

final def setDefault(paramPairs: ParamPair[_]*): JavaParams.this.type

final def setDefault[T](param: Param[T], value: T): JavaParams.this.type

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Members