Trait

com.microsoft.ml.spark

LightGBMBase

Related Doc: package spark

Permalink

trait LightGBMBase[TrainedModel <: Model[TrainedModel]] extends Estimator[TrainedModel] with LightGBMParams with org.apache.spark.ml.param.shared.HasFeaturesCol with org.apache.spark.ml.param.shared.HasLabelCol

Linear Supertypes
org.apache.spark.ml.param.shared.HasLabelCol, org.apache.spark.ml.param.shared.HasFeaturesCol, LightGBMParams, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, Estimator[TrainedModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. LightGBMBase
  2. HasLabelCol
  3. HasFeaturesCol
  4. LightGBMParams
  5. HasValidationIndicatorCol
  6. HasWeightCol
  7. DefaultParamsWritable
  8. MLWritable
  9. Wrappable
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. 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
    Attributes
    protected
  4. abstract def getTrainParams(numWorkers: Int, categoricalIndexes: Array[Int], dataset: Dataset[_]): TrainParams

    Permalink
    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
    LightGBMParams
  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
    LightGBMParams
  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. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  46. def getLambdaL1: Double

    Permalink
    Definition Classes
    LightGBMParams
  47. def getLambdaL2: Double

    Permalink
    Definition Classes
    LightGBMParams
  48. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  49. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  50. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  51. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  52. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  53. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMParams
  54. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  55. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  56. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams
  57. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  58. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMParams
  59. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  60. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  61. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  62. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  63. def getWeightCol: String

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  67. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  75. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  76. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  77. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  78. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  91. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  92. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  97. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  98. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  99. val numLeaves: IntParam

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

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

    Permalink
    Definition Classes
    LightGBMParams
  102. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  103. def save(path: String): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  117. def setEarlyStoppingRound(value: Int): LightGBMBase.this.type

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

    Permalink
    Definition Classes
    LightGBMParams
  119. def setLambdaL1(value: Double): LightGBMBase.this.type

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  131. def setTimeout(value: Double): LightGBMBase.this.type

    Permalink
    Definition Classes
    LightGBMParams
  132. def setValidationIndicatorCol(value: String): LightGBMBase.this.type

    Permalink

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

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

    Permalink

    Definition Classes
    HasWeightCol
  135. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  136. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  137. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  138. 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
  139. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  140. val validationIndicatorCol: Param[String]

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  141. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  146. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from org.apache.spark.ml.param.shared.HasLabelCol

Inherited from org.apache.spark.ml.param.shared.HasFeaturesCol

Inherited from LightGBMParams

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Estimator[TrainedModel]

Inherited from PipelineStage

Inherited from org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members