Class/Object

com.microsoft.ml.spark.lightgbm

LightGBMClassificationModel

Related Docs: object LightGBMClassificationModel | package lightgbm

Permalink

class LightGBMClassificationModel extends ProbabilisticClassificationModel[Vector, LightGBMClassificationModel] with HasFeatureImportanceGetters with ConstructorWritable[LightGBMClassificationModel]

Model produced by LightGBMClassifier.

Annotations
@InternalWrapper()
Linear Supertypes
ConstructorWritable[LightGBMClassificationModel], MLWritable, HasFeatureImportanceGetters, 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. ConstructorWritable
  3. MLWritable
  4. HasFeatureImportanceGetters
  5. ProbabilisticClassificationModel
  6. ProbabilisticClassifierParams
  7. HasThresholds
  8. HasProbabilityCol
  9. ClassificationModel
  10. ClassifierParams
  11. HasRawPredictionCol
  12. PredictionModel
  13. PredictorParams
  14. HasPredictionCol
  15. HasFeaturesCol
  16. HasLabelCol
  17. Model
  18. Transformer
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMClassificationModel(uid: String, model: LightGBMBooster, labelColName: String, featuresColName: String, predictionColName: String, probColName: String, rawPredictionColName: String, thresholdValues: Option[Array[Double]], actualNumClasses: Int)

    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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def copy(extra: ParamMap): LightGBMClassificationModel

    Permalink
    Definition Classes
    LightGBMClassificationModel → Model → Transformer → PipelineStage → Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  10. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  14. def explainParams(): String

    Permalink
    Definition Classes
    Params

  15. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  16. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  17. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol

  18. def featuresDataType: DataType

    Permalink
    Attributes
    protected
    Definition Classes
    PredictionModel

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  23. def getFeatureImportances(importanceType: String): Array[Double]

    Permalink
    Definition Classes
    HasFeatureImportanceGetters

  24. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol

  25. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol

  26. def getModel: LightGBMBooster

    Permalink

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

    Permalink
    Definition Classes
    Params

  28. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  29. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol

  30. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol

  31. final def getRawPredictionCol: String

    Permalink
    Definition Classes
    HasRawPredictionCol

  32. def getThresholds: Array[Double]

    Permalink
    Definition Classes
    HasThresholds

  33. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  34. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  35. def hasParent: Boolean

    Permalink
    Definition Classes
    Model

  36. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  37. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  38. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    Params

  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  42. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  43. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol

  44. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  45. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  55. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. val model: LightGBMBooster

    Permalink
    Definition Classes
    LightGBMClassificationModel → HasFeatureImportanceGetters

  57. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  58. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  59. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  60. def numClasses: Int

    Permalink
    Definition Classes
    LightGBMClassificationModel → ClassificationModel

  61. def numFeatures: Int

    Permalink
    Definition Classes
    PredictionModel
    Annotations
    @Since( "1.6.0" )

  62. def objectsToSave: List[Any]

    Permalink
    Definition Classes
    LightGBMClassificationModel → ConstructorWritable

  63. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  64. var parent: Estimator[LightGBMClassificationModel]

    Permalink
    Definition Classes
    Model

  65. def predict(features: Vector): Double

    Permalink
    Definition Classes
    ClassificationModel → PredictionModel

  66. def predictProbability(features: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ProbabilisticClassificationModel

  67. def predictRaw(features: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ClassificationModel

  68. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol

  69. def probability2prediction(probability: Vector): Double

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel

  70. final val probabilityCol: Param[String]

    Permalink
    Definition Classes
    HasProbabilityCol

  71. def raw2prediction(rawPrediction: Vector): Double

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel → ClassificationModel

  72. def raw2probability(rawPrediction: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel

  73. def raw2probabilityInPlace(rawPrediction: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMClassificationModel → ProbabilisticClassificationModel

  74. final val rawPredictionCol: Param[String]

    Permalink
    Definition Classes
    HasRawPredictionCol

  75. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  76. def saveNativeModel(filename: String, overwrite: Boolean): Unit

    Permalink

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  82. def setFeaturesCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    PredictionModel

  83. def setParent(parent: Estimator[LightGBMClassificationModel]): LightGBMClassificationModel

    Permalink
    Definition Classes
    Model

  84. def setPredictionCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    PredictionModel

  85. def setProbabilityCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel

  86. def setRawPredictionCol(value: String): LightGBMClassificationModel

    Permalink
    Definition Classes
    ClassificationModel

  87. def setThresholds(value: Array[Double]): LightGBMClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel

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

    Permalink
    Definition Classes
    AnyRef

  89. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds

  90. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  91. 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

  92. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  93. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  94. def transformImpl(dataset: Dataset[_]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    PredictionModel

  95. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PredictionModel → PipelineStage

  96. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  97. val ttag: scala.reflect.api.JavaUniverse.TypeTag[LightGBMClassificationModel]

    Permalink
    Definition Classes
    LightGBMClassificationModel → ConstructorWritable

  98. val uid: String

    Permalink
    Definition Classes
    LightGBMClassificationModel → ConstructorWritable → Identifiable

  99. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams

  100. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  101. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  102. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  103. def write: MLWriter

    Permalink
    Definition Classes
    ConstructorWritable → MLWritable

Inherited from ConstructorWritable[LightGBMClassificationModel]

Inherited from MLWritable

Inherited from HasFeatureImportanceGetters

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