GeneralParams

Abstract Value Members

abstract def copy(extra: ParamMap): Params

Definition Classes
Params
abstract val uid: String

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

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

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

Definition Classes
Any
val checkpointInterval: IntParam

Param for set checkpoint interval (>= 1) or disable checkpoint (-1).
Param for set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the trained model will get checkpointed every 10 iterations. Note: checkpoint_path must also be set if the checkpoint interval is greater than 0.
val checkpointPath: Param[String]

The hdfs folder to load and save checkpoint boosters.
The hdfs folder to load and save checkpoint boosters. default: empty_string
final def clear(param: Param[_]): GeneralParams.this.type

Definition Classes
Params
def clone(): AnyRef

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

Attributes
protected
Definition Classes
Params
val customEval: CustomEvalParam

customized evaluation function provided by user.
customized evaluation function provided by user. default: null
val customObj: CustomObjParam

customized objective function provided by user.
customized objective function provided by user. default: null
final def defaultCopy[T <: Params](extra: ParamMap): T

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

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

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

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]

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

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

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

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

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

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

Definition Classes
Params
def hashCode(): Int

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

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Params
val missing: FloatParam

the value treated as missing.
the value treated as missing. default: Float.NaN
val nWorkers: IntParam

number of workers used to train xgboost model.
number of workers used to train xgboost model. default: 1
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numThreadPerTask: IntParam

number of threads used by per worker.
number of threads used by per worker. default 1
lazy val params: Array[Param[_]]

Definition Classes
Params
val round: IntParam

The number of rounds for boosting
val seed: LongParam

Random seed for the C++ part of XGBoost and train/test splitting.
final def set(paramPair: ParamPair[_]): GeneralParams.this.type

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

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

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

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

Attributes
protected
Definition Classes
Params
val silent: IntParam

0 means printing running messages, 1 means silent mode.
0 means printing running messages, 1 means silent mode. default: 0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeoutRequestWorkers: LongParam

the maximum time to wait for the job requesting new workers.
the maximum time to wait for the job requesting new workers. default: 30 minutes
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
val trackerConf: TrackerConfParam

Rabit tracker configurations.
Rabit tracker configurations. The parameter must be provided as an instance of the TrackerConf class, which has the following definition:
case class TrackerConf(workerConnectionTimeout: Duration, trainingTimeout: Duration, trackerImpl: String)
See below for detailed explanations.
- trackerImpl: Select the implementation of Rabit tracker. default: "python"
Choice between "python" or "scala". The former utilizes the Java wrapper of the Python Rabit tracker (in dmlc_core), and does not support timeout settings. The "scala" version removes Python components, and fully supports timeout settings.
- workerConnectionTimeout: the maximum wait time for all workers to connect to the tracker. default: 0 millisecond (no timeout)
The timeout value should take the time of data loading and pre-processing into account, due to the lazy execution of Spark's operations. Alternatively, you may force Spark to perform data transformation before calling XGBoost.train(), so that this timeout truly reflects the connection delay. Set a reasonable timeout value to prevent model training/testing from hanging indefinitely, possible due to network issues. Note that zero timeout value means to wait indefinitely (equivalent to Duration.Inf). Ignored if the tracker implementation is "python".
val useExternalMemory: BooleanParam

whether to use external memory as cache.
whether to use external memory as cache. default: false
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 params

trait GeneralParams extends Params

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

val checkpointInterval: IntParam

val checkpointPath: Param[String]

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

def clone(): AnyRef

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

val customEval: CustomEvalParam

val customObj: CustomObjParam

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

val missing: FloatParam

val nWorkers: IntParam

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numThreadPerTask: IntParam

lazy val params: Array[Param[_]]

val round: IntParam

val seed: LongParam

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

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

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

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

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

val silent: IntParam

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

val timeoutRequestWorkers: LongParam

def toString(): String

val trackerConf: TrackerConfParam

val useExternalMemory: BooleanParam

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

Ungrouped