Class/Object

com.microsoft.ml.spark.lightgbm

LightGBMClassificationModel

Related Docs: object LightGBMClassificationModel | package lightgbm

Permalink

class LightGBMClassificationModel extends ProbabilisticClassificationModel[Vector, LightGBMClassificationModel] with LightGBMModelParams with LightGBMModelMethods with LightGBMPredictionParams with HasActualNumClasses with ComplexParamsWritable

Model produced by LightGBMClassifier.

Annotations
@InternalWrapper()
Linear Supertypes
ComplexParamsWritable, MLWritable, HasActualNumClasses, LightGBMPredictionParams, LightGBMModelMethods, LightGBMModelParams, Wrappable, HasAdditionalPythonMethods, ProbabilisticClassificationModel[Vector, LightGBMClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, ClassificationModel[Vector, LightGBMClassificationModel], ClassifierParams, HasRawPredictionCol, PredictionModel[Vector, LightGBMClassificationModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Model[LightGBMClassificationModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMClassificationModel
  2. ComplexParamsWritable
  3. MLWritable
  4. HasActualNumClasses
  5. LightGBMPredictionParams
  6. LightGBMModelMethods
  7. LightGBMModelParams
  8. Wrappable
  9. HasAdditionalPythonMethods
  10. ProbabilisticClassificationModel
  11. ProbabilisticClassifierParams
  12. HasThresholds
  13. HasProbabilityCol
  14. ClassificationModel
  15. ClassifierParams
  16. HasRawPredictionCol
  17. PredictionModel
  18. PredictorParams
  19. HasPredictionCol
  20. HasFeaturesCol
  21. HasLabelCol
  22. Model
  23. Transformer
  24. PipelineStage
  25. Logging
  26. Params
  27. Serializable
  28. Serializable
  29. Identifiable
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMClassificationModel(uid: String)

    Permalink

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. val actualNumClasses: IntParam

    Permalink
    Definition Classes
    HasActualNumClasses
  6. def additionalPythonMethods(): String

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def copy(extra: ParamMap): LightGBMClassificationModel

    Permalink
    Definition Classes
    LightGBMClassificationModel → Model → Transformer → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  19. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  20. def featuresDataType: DataType

    Permalink
    Attributes
    protected
    Definition Classes
    PredictionModel
  21. def featuresShap(features: Vector): Vector

    Permalink

    Protected method to predict local SHAP feature importance values for an instance.

    Protected method to predict local SHAP feature importance values for an instance.

    features

    The local instance or row to compute the local SHAP values for.

    returns

    The SHAP local feature importance values.

    Attributes
    protected
    Definition Classes
    LightGBMModelMethods
  22. val featuresShapCol: Param[String]

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

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

    Permalink
    Definition Classes
    Params
  25. def getActualNumClasses: Int

    Permalink
    Definition Classes
    HasActualNumClasses
  26. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  28. def getDenseFeatureShaps(features: Array[Double]): Array[Double]

    Permalink

    Public method for pyspark API to get the dense local SHAP feature importance values for an instance.

    Public method for pyspark API to get the dense local SHAP feature importance values for an instance.

    features

    The local instance or row to compute the SHAP values for.

    returns

    The local feature importance values.

    Definition Classes
    LightGBMModelMethods
  29. def getFeatureImportances(importanceType: String): Array[Double]

    Permalink

    Public method to get the global feature importance values.

    Public method to get the global feature importance values.

    importanceType

    split or gini

    returns

    The global feature importance values.

    Definition Classes
    LightGBMModelMethods
  30. def getFeatureShaps(features: Vector): Array[Double]

    Permalink

    Public method to get the vector local SHAP feature importance values for an instance.

    Public method to get the vector local SHAP feature importance values for an instance.

    features

    The local instance or row to compute the SHAP values for.

    returns

    The local feature importance values.

    Definition Classes
    LightGBMModelMethods
  31. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  32. def getFeaturesShapCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  33. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  34. def getLeafPredictionCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  35. def getLightGBMBooster: LightGBMBooster

    Permalink
    Definition Classes
    LightGBMModelParams
  36. def getModel: LightGBMBooster

    Permalink

    Alias for same method

    Alias for same method

    returns

    The LightGBM Booster.

    Definition Classes
    LightGBMModelParams
  37. final def getOrDefault[T](param: Param[T]): T

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

    Permalink
    Definition Classes
    Params
  39. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  40. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol
  41. final def getRawPredictionCol: String

    Permalink
    Definition Classes
    HasRawPredictionCol
  42. def getSparseFeatureShaps(size: Int, indices: Array[Int], values: Array[Double]): Array[Double]

    Permalink

    Public method for pyspark API to get the sparse local SHAP feature importance values for an instance.

    Public method for pyspark API to get the sparse local SHAP feature importance values for an instance.

    returns

    The local feature importance values.

    Definition Classes
    LightGBMModelMethods
  43. def getThresholds: Array[Double]

    Permalink
    Definition Classes
    HasThresholds
  44. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  46. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  47. def hashCode(): Int

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  55. val leafPredictionCol: Param[String]

    Permalink
    Definition Classes
    LightGBMPredictionParams
  56. val lightGBMBooster: LightGBMBoosterParam

    Permalink
    Definition Classes
    LightGBMModelParams
  57. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  72. def numClasses: Int

    Permalink
    Definition Classes
    LightGBMClassificationModel → ClassificationModel
  73. def numFeatures: Int

    Permalink
    Definition Classes
    PredictionModel
    Annotations
    @Since( "1.6.0" )
  74. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  75. var parent: Estimator[LightGBMClassificationModel]

    Permalink
    Definition Classes
    Model
  76. def predict(features: Vector): Double

    Permalink
    Definition Classes
    ClassificationModel → PredictionModel
  77. def predictColumn: Column

    Permalink
    Attributes
    protected
  78. def predictLeaf(features: Vector): Vector

    Permalink

    Protected method to predict leaf index.

    Protected method to predict leaf index.

    features

    The local instance or row to compute the leaf index for.

    returns

    The predicted leaf index.

    Attributes
    protected
    Definition Classes
    LightGBMModelMethods
  79. def predictProbability(features: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ProbabilisticClassificationModel
  80. def predictRaw(features: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ClassificationModel
  81. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  82. def probability2prediction(probability: Vector): Double

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  83. final val probabilityCol: Param[String]

    Permalink
    Definition Classes
    HasProbabilityCol
  84. def raw2prediction(rawPrediction: Vector): Double

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel → ClassificationModel
  85. def raw2probability(rawPrediction: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  86. def raw2probabilityInPlace(rawPrediction: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ProbabilisticClassificationModel
  87. final val rawPredictionCol: Param[String]

    Permalink
    Definition Classes
    HasRawPredictionCol
  88. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  89. def saveNativeModel(filename: String, overwrite: Boolean): Unit

    Permalink
  90. final def set(paramPair: ParamPair[_]): LightGBMClassificationModel.this.type

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

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

    Permalink
    Definition Classes
    Params
  93. def setActualNumClasses(value: Int): LightGBMClassificationModel.this.type

    Permalink
    Definition Classes
    HasActualNumClasses
  94. final def setDefault(paramPairs: ParamPair[_]*): LightGBMClassificationModel.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  96. def setFeaturesCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    PredictionModel
  97. def setFeaturesShapCol(value: String): LightGBMClassificationModel.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  98. def setLeafPredictionCol(value: String): LightGBMClassificationModel.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  99. def setLightGBMBooster(value: LightGBMBooster): LightGBMClassificationModel.this.type

    Permalink
    Definition Classes
    LightGBMModelParams
  100. def setParent(parent: Estimator[LightGBMClassificationModel]): LightGBMClassificationModel

    Permalink
    Definition Classes
    Model
  101. def setPredictionCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    PredictionModel
  102. def setProbabilityCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel
  103. def setRawPredictionCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    ClassificationModel
  104. def setThresholds(value: Array[Double]): LightGBMClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel
  105. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  106. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds
  107. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  108. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Implementation based on ProbabilisticClassifier with slight modifications to avoid calling raw2probabilityInPlace to defer the probability calculation to lightgbm native code.

    Implementation based on ProbabilisticClassifier with slight modifications to avoid calling raw2probabilityInPlace to defer the probability calculation to lightgbm native code.

    dataset

    input dataset

    returns

    transformed dataset

    Definition Classes
    LightGBMClassificationModel → ProbabilisticClassificationModel → ClassificationModel → PredictionModel → Transformer
  109. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  110. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  111. def transformImpl(dataset: Dataset[_]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    PredictionModel
  112. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PredictionModel → PipelineStage
  113. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  114. val uid: String

    Permalink
    Definition Classes
    LightGBMClassificationModel → Identifiable
  115. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  116. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from HasActualNumClasses

Inherited from LightGBMPredictionParams

Inherited from LightGBMModelMethods

Inherited from LightGBMModelParams

Inherited from Wrappable

Inherited from ProbabilisticClassificationModel[Vector, LightGBMClassificationModel]

Inherited from ProbabilisticClassifierParams

Inherited from HasThresholds

Inherited from HasProbabilityCol

Inherited from ClassificationModel[Vector, LightGBMClassificationModel]

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from PredictionModel[Vector, LightGBMClassificationModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Model[LightGBMClassificationModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped