Trait

com.microsoft.ml.spark.lightgbm

LightGBMModelMethods

Related Doc: package lightgbm

Permalink

trait LightGBMModelMethods extends LightGBMModelParams

Contains common LightGBM model methods across all LightGBM learner types.

Linear Supertypes
LightGBMModelParams, Wrappable, HasAdditionalPythonMethods, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMModelMethods
  2. LightGBMModelParams
  3. Wrappable
  4. HasAdditionalPythonMethods
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. 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. final def clear(param: Param[_]): LightGBMModelMethods.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. 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
  18. def finalize(): Unit

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

    Permalink
    Definition Classes
    Params
  20. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  22. 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.

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

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

  25. def getLightGBMBooster: LightGBMBooster

    Permalink
    Definition Classes
    LightGBMModelParams
  26. def getModel: LightGBMBooster

    Permalink

    Alias for same method

    Alias for same method

    returns

    The LightGBM Booster.

    Definition Classes
    LightGBMModelParams
  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. 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.

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def isDefined(param: Param[_]): Boolean

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

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

    Permalink
    Definition Classes
    Params
  36. val lightGBMBooster: LightGBMBoosterParam

    Permalink
    Definition Classes
    LightGBMModelParams
  37. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  40. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  41. 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
  42. final def set(paramPair: ParamPair[_]): LightGBMModelMethods.this.type

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

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

    Permalink
    Definition Classes
    Params
  45. final def setDefault(paramPairs: ParamPair[_]*): LightGBMModelMethods.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  47. def setLightGBMBooster(value: LightGBMBooster): LightGBMModelMethods.this.type

    Permalink
    Definition Classes
    LightGBMModelParams
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  50. final def wait(): Unit

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

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

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

Inherited from LightGBMModelParams

Inherited from Wrappable

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped