Trait

com.microsoft.ml.spark.lightgbm

LightGBMBase

Related Doc: package lightgbm

Permalink

trait LightGBMBase[TrainedModel <: Model[TrainedModel]] extends Estimator[TrainedModel] with LightGBMParams with HasFeaturesCol with HasLabelCol

Linear Supertypes
HasLabelCol, HasFeaturesCol, LightGBMParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, Estimator[TrainedModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMBase
  2. HasLabelCol
  3. HasFeaturesCol
  4. LightGBMParams
  5. LightGBMExecutionParams
  6. HasInitScoreCol
  7. HasValidationIndicatorCol
  8. HasWeightCol
  9. DefaultParamsWritable
  10. MLWritable
  11. Wrappable
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Estimator[TrainedModel]

    Permalink
    Definition Classes
    Estimator → PipelineStage → Params
  2. abstract def fit(dataset: Dataset[_]): TrainedModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  3. abstract def getModel(trainParams: TrainParams, lightGBMBooster: LightGBMBooster): TrainedModel

    Permalink

    Gets the trained model given the train parameters and booster.

    Gets the trained model given the train parameters and booster.

    returns

    trained model.

    Attributes
    protected
  4. abstract def getTrainParams(numWorkers: Int, categoricalIndexes: Array[Int], dataset: Dataset[_]): TrainParams

    Permalink

    Gets the training parameters.

    Gets the training parameters.

    returns

    train parameters.

    Attributes
    protected
  5. abstract def stringFromTrainedModel(model: TrainedModel): String

    Permalink
    Attributes
    protected
  6. abstract def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  7. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

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

    Permalink
    Definition Classes
    Any
  6. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  7. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  8. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  9. val boostFromAverage: BooleanParam

    Permalink
    Definition Classes
    LightGBMParams
  10. val boostingType: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  11. val categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  12. val categoricalSlotNames: StringArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  13. final def clear(param: Param[_]): LightGBMBase.this.type

    Permalink
    Definition Classes
    Params
  14. def clone(): AnyRef

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. val defaultListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  18. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Params
  22. def explainParams(): String

    Permalink
    Definition Classes
    Params
  23. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  24. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  25. val featureFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  26. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[TrainedModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  29. def fit(dataset: Dataset[_], paramMap: ParamMap): TrainedModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  30. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TrainedModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  31. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  32. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  33. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  34. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams
  35. def getBoostFromAverage: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  36. def getBoostingType: String

    Permalink
    Definition Classes
    LightGBMParams
  37. def getCategoricalSlotIndexes: Array[Int]

    Permalink
    Definition Classes
    LightGBMParams
  38. def getCategoricalSlotNames: Array[String]

    Permalink
    Definition Classes
    LightGBMParams
  39. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  41. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  42. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  43. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  44. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  45. def getInitScoreCol: String

    Permalink

    Definition Classes
    HasInitScoreCol
  46. def getIsProvideTrainingMetric: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  47. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  48. def getLambdaL1: Double

    Permalink
    Definition Classes
    LightGBMParams
  49. def getLambdaL2: Double

    Permalink
    Definition Classes
    LightGBMParams
  50. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  51. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  52. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  53. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  54. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  55. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMParams
  56. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  57. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  58. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams
  59. def getOptGroupCol: Option[String]

    Permalink

    Optional group column for Ranking, set to None by default.

    Optional group column for Ranking, set to None by default.

    returns

    None

    Attributes
    protected
  60. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  61. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMExecutionParams
  62. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  63. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMExecutionParams
  64. def getUseBarrierExecutionMode: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  65. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  66. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  67. def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  68. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  69. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  70. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  71. val initScoreCol: Param[String]

    Permalink

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  72. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def innerTrain(dataset: Dataset[_]): TrainedModel

    Permalink
    Attributes
    protected
  75. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  76. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  77. val isProvideTrainingMetric: BooleanParam

    Permalink
    Definition Classes
    LightGBMParams
  78. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  79. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  81. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  82. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  83. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  84. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  85. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  86. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  87. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  88. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  89. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  90. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  91. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  92. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  93. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  94. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  95. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  96. val maxBin: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  97. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  98. val minSumHessianInLeaf: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  99. val modelString: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  100. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  101. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  102. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  103. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  104. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  105. val numLeaves: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  106. val objective: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  107. val parallelism: Param[String]

    Permalink
    Definition Classes
    LightGBMExecutionParams
  108. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  109. def preprocessData(dataset: DataFrame): DataFrame

    Permalink

    Allow algorithm specific preprocessing of dataset.

    Allow algorithm specific preprocessing of dataset.

    dataset

    The dataset to preprocess prior to training.

    returns

    The preprocessed data.

    Attributes
    protected
  110. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  111. final def set(paramPair: ParamPair[_]): LightGBMBase.this.type

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

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

    Permalink
    Definition Classes
    Params
  114. def setBaggingFraction(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  115. def setBaggingFreq(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  116. def setBaggingSeed(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  117. def setBoostFromAverage(value: Boolean): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  118. def setBoostingType(value: String): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  119. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  120. def setCategoricalSlotNames(value: Array[String]): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  121. final def setDefault(paramPairs: ParamPair[_]*): LightGBMBase.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  123. def setDefaultListenPort(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  124. def setEarlyStoppingRound(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  125. def setFeatureFraction(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  126. def setInitScoreCol(value: String): LightGBMBase.this.type

    Permalink

    Definition Classes
    HasInitScoreCol
  127. def setLambdaL1(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  128. def setLambdaL2(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  129. def setLearningRate(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  130. def setMaxBin(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  131. def setMaxDepth(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  132. def setMinSumHessianInLeaf(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  133. def setModelString(value: String): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  134. def setNumBatches(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  135. def setNumIterations(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  136. def setNumLeaves(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  137. def setObjective(value: String): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  138. def setParallelism(value: String): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  139. def setTimeout(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  140. def setUseBarrierExecutionMode(value: Boolean): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  141. def setValidationIndicatorCol(value: String): LightGBMBase.this.type

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  142. def setVerbosity(value: Int): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  143. def setWeightCol(value: String): LightGBMBase.this.type

    Permalink

    Definition Classes
    HasWeightCol
  144. def setisProvideTrainingMetric(value: Boolean): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  145. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  146. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  147. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  148. def train(dataset: Dataset[_]): TrainedModel

    Permalink

    Trains the LightGBM model.

    Trains the LightGBM model.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
  149. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  150. val useBarrierExecutionMode: BooleanParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  151. val validationIndicatorCol: Param[String]

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  152. val verbosity: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  153. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. val weightCol: Param[String]

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  157. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from HasLabelCol

Inherited from HasFeaturesCol

Inherited from LightGBMParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Estimator[TrainedModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped