Trait

com.microsoft.ml.spark.lightgbm

LightGBMParams

Related Doc: package lightgbm

Permalink

trait LightGBMParams extends Wrappable with DefaultParamsWritable with HasWeightCol with HasValidationIndicatorCol with HasInitScoreCol with LightGBMExecutionParams with LightGBMSlotParams with LightGBMFractionParams with LightGBMBinParams with LightGBMLearnerParams with LightGBMPredictionParams

Defines common parameters across all LightGBM learners.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMParams
  2. LightGBMPredictionParams
  3. LightGBMLearnerParams
  4. LightGBMBinParams
  5. LightGBMFractionParams
  6. LightGBMSlotParams
  7. LightGBMExecutionParams
  8. HasInitScoreCol
  9. HasValidationIndicatorCol
  10. HasWeightCol
  11. DefaultParamsWritable
  12. MLWritable
  13. Wrappable
  14. HasAdditionalPythonMethods
  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): Params

    Permalink
    Definition Classes
    Params
  2. 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. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    HasAdditionalPythonMethods
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  8. val baggingFreq: IntParam

    Permalink
  9. val baggingSeed: IntParam

    Permalink
  10. val binSampleCount: IntParam

    Permalink
    Definition Classes
    LightGBMBinParams
  11. val boostFromAverage: BooleanParam

    Permalink
  12. val boostingType: Param[String]

    Permalink
  13. val categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMSlotParams
  14. val categoricalSlotNames: StringArrayParam

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  20. var delegate: Option[LightGBMDelegate]

    Permalink
  21. val driverListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  22. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMLearnerParams
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  29. val featureFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  30. val featuresShapCol: Param[String]

    Permalink
    Definition Classes
    LightGBMPredictionParams
  31. def finalize(): Unit

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

    Permalink
    Definition Classes
    Params
  33. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  34. def getBaggingFreq: Int

    Permalink
  35. def getBaggingSeed: Int

    Permalink
  36. def getBinSampleCount: Int

    Permalink
    Definition Classes
    LightGBMBinParams
  37. def getBoostFromAverage: Boolean

    Permalink
  38. def getBoostingType: String

    Permalink
  39. def getCategoricalSlotIndexes: Array[Int]

    Permalink
    Definition Classes
    LightGBMSlotParams
  40. def getCategoricalSlotNames: Array[String]

    Permalink
    Definition Classes
    LightGBMSlotParams
  41. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  43. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  44. def getDelegate: Option[LightGBMDelegate]

    Permalink
  45. def getDriverListenPort: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  46. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMLearnerParams
  47. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  48. def getFeaturesShapCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  49. def getImprovementTolerance: Double

    Permalink
    Definition Classes
    LightGBMLearnerParams
  50. def getInitScoreCol: String

    Permalink

    Definition Classes
    HasInitScoreCol
  51. def getIsProvideTrainingMetric: Boolean

    Permalink
  52. def getLambdaL1: Double

    Permalink
  53. def getLambdaL2: Double

    Permalink
  54. def getLeafPredictionCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  55. def getLearningRate: Double

    Permalink
  56. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMBinParams
  57. def getMaxBinByFeature: Array[Int]

    Permalink
  58. def getMaxDeltaStep: Double

    Permalink
  59. def getMaxDepth: Int

    Permalink
  60. def getMetric: String

    Permalink
  61. def getMinDataInLeaf: Int

    Permalink
  62. def getMinGainToSplit: Double

    Permalink
  63. def getMinSumHessianInLeaf: Double

    Permalink
  64. def getModelString: String

    Permalink
  65. def getNegBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  66. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  67. def getNumIterations: Int

    Permalink
  68. def getNumLeaves: Int

    Permalink
  69. def getNumTasks: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  70. def getObjective: String

    Permalink
  71. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  72. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  74. def getPosBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  75. def getRepartitionByGroupingColumn: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  76. def getSlotNames: Array[String]

    Permalink
    Definition Classes
    LightGBMSlotParams
  77. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMExecutionParams
  78. def getTopK: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  79. def getUseBarrierExecutionMode: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  80. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  81. def getVerbosity: Int

    Permalink
  82. def getWeightCol: String

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  86. val improvementTolerance: DoubleParam

    Permalink
    Definition Classes
    LightGBMLearnerParams
  87. val initScoreCol: Param[String]

    Permalink

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  88. final def isDefined(param: Param[_]): Boolean

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

    Permalink
    Definition Classes
    Any
  90. val isProvideTrainingMetric: BooleanParam

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

    Permalink
    Definition Classes
    Params
  92. val lambdaL1: DoubleParam

    Permalink
  93. val lambdaL2: DoubleParam

    Permalink
  94. val leafPredictionCol: Param[String]

    Permalink
    Definition Classes
    LightGBMPredictionParams
  95. val learningRate: DoubleParam

    Permalink
  96. val maxBin: IntParam

    Permalink
    Definition Classes
    LightGBMBinParams
  97. val maxBinByFeature: IntArrayParam

    Permalink
  98. val maxDeltaStep: DoubleParam

    Permalink
  99. val maxDepth: IntParam

    Permalink
  100. val metric: Param[String]

    Permalink
  101. val minDataInLeaf: IntParam

    Permalink
  102. val minGainToSplit: DoubleParam

    Permalink
  103. val minSumHessianInLeaf: DoubleParam

    Permalink
  104. val modelString: Param[String]

    Permalink
  105. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  106. val negBaggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  107. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  109. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  110. val numIterations: IntParam

    Permalink
  111. val numLeaves: IntParam

    Permalink
  112. val numTasks: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  113. val objective: Param[String]

    Permalink
  114. val parallelism: Param[String]

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

    Permalink
    Definition Classes
    Params
  116. val posBaggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  117. val repartitionByGroupingColumn: BooleanParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  118. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  122. def setBaggingFraction(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  123. def setBaggingFreq(value: Int): LightGBMParams.this.type

    Permalink
  124. def setBaggingSeed(value: Int): LightGBMParams.this.type

    Permalink
  125. def setBinSampleCount(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMBinParams
  126. def setBoostFromAverage(value: Boolean): LightGBMParams.this.type

    Permalink
  127. def setBoostingType(value: String): LightGBMParams.this.type

    Permalink
  128. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMParams.this.type

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

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

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

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  133. def setDelegate(delegate: LightGBMDelegate): LightGBMParams.this.type

    Permalink
  134. def setDriverListenPort(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  135. def setEarlyStoppingRound(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMLearnerParams
  136. def setFeatureFraction(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  137. def setFeaturesShapCol(value: String): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  138. def setImprovementTolerance(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMLearnerParams
  139. def setInitScoreCol(value: String): LightGBMParams.this.type

    Permalink

    Definition Classes
    HasInitScoreCol
  140. def setIsProvideTrainingMetric(value: Boolean): LightGBMParams.this.type

    Permalink
  141. def setLambdaL1(value: Double): LightGBMParams.this.type

    Permalink
  142. def setLambdaL2(value: Double): LightGBMParams.this.type

    Permalink
  143. def setLeafPredictionCol(value: String): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  144. def setLearningRate(value: Double): LightGBMParams.this.type

    Permalink
  145. def setMaxBin(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMBinParams
  146. def setMaxBinByFeature(value: Array[Int]): LightGBMParams.this.type

    Permalink
  147. def setMaxDeltaStep(value: Double): LightGBMParams.this.type

    Permalink
  148. def setMaxDepth(value: Int): LightGBMParams.this.type

    Permalink
  149. def setMetric(value: String): LightGBMParams.this.type

    Permalink
  150. def setMinDataInLeaf(value: Int): LightGBMParams.this.type

    Permalink
  151. def setMinGainToSplit(value: Double): LightGBMParams.this.type

    Permalink
  152. def setMinSumHessianInLeaf(value: Double): LightGBMParams.this.type

    Permalink
  153. def setModelString(value: String): LightGBMParams.this.type

    Permalink
  154. def setNegBaggingFraction(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  155. def setNumBatches(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  156. def setNumIterations(value: Int): LightGBMParams.this.type

    Permalink
  157. def setNumLeaves(value: Int): LightGBMParams.this.type

    Permalink
  158. def setNumTasks(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  159. def setObjective(value: String): LightGBMParams.this.type

    Permalink
  160. def setParallelism(value: String): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  161. def setPosBaggingFraction(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  162. def setRepartitionByGroupingColumn(value: Boolean): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  163. def setSlotNames(value: Array[String]): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMSlotParams
  164. def setTimeout(value: Double): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  165. def setTopK(value: Int): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  166. def setUseBarrierExecutionMode(value: Boolean): LightGBMParams.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  167. def setValidationIndicatorCol(value: String): LightGBMParams.this.type

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  168. def setVerbosity(value: Int): LightGBMParams.this.type

    Permalink
  169. def setWeightCol(value: String): LightGBMParams.this.type

    Permalink

    Definition Classes
    HasWeightCol
  170. val slotNames: StringArrayParam

    Permalink
    Definition Classes
    LightGBMSlotParams
  171. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  172. val timeout: DoubleParam

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  174. val topK: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  175. val useBarrierExecutionMode: BooleanParam

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

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  177. val verbosity: IntParam

    Permalink
  178. final def wait(): Unit

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  182. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMPredictionParams

Inherited from LightGBMLearnerParams

Inherited from LightGBMBinParams

Inherited from LightGBMFractionParams

Inherited from LightGBMSlotParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped