t

com.microsoft.azure.synapse.ml.lightgbm

LightGBMModelMethods

trait LightGBMModelMethods extends LightGBMModelParams with Logging

Contains common LightGBM model methods across all LightGBM learner types.

Linear Supertypes
Logging, LightGBMModelParams, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
LightGBMClassificationModel, LightGBMRankerModel, LightGBMRegressionModel
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMModelMethods
  2. Logging
  3. LightGBMModelParams
  4. Wrappable
  5. RWrappable
  6. PythonWrappable
  7. BaseWrappable
  8. Params
  9. Serializable
  10. Serializable
  11. Identifiable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  7. final def clear(param: Param[_]): LightGBMModelMethods.this.type
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  11. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  12. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  19. def featuresShap(features: Vector): Vector

    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
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  22. def getBoosterBestIteration(): Int

    Public method to get the best iteration from the booster.

    Public method to get the best iteration from the booster.

    returns

    The best iteration, if early stopping was triggered.

  23. def getBoosterNumClasses(): Int

    Public method to get the number of classes from the booster.

    Public method to get the number of classes from the booster.

    returns

    The number of classes.

  24. def getBoosterNumFeatures(): Int

    Public method to get the number of features from the booster.

    Public method to get the number of features from the booster.

    returns

    The number of features.

  25. def getBoosterNumTotalIterations(): Int

    Public method to get the total number of iterations trained.

    Public method to get the total number of iterations trained.

    returns

    The total number of iterations trained.

  26. def getBoosterNumTotalModel(): Int

    Public method to get the total number of models trained.

    Public method to get the total number of models trained. Note this may be larger than the number of iterations, since in multiclass a model is trained per class for each iteration.

    returns

    The total number of models.

  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getDenseFeatureShaps(features: Array[Double]): Array[Double]

    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.

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

    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.

  31. def getFeatureShaps(features: Vector): Array[Double]

    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.

  32. def getLightGBMBooster: LightGBMBooster
    Definition Classes
    LightGBMModelParams
  33. def getModel: LightGBMBooster

    Alias for same method

    Alias for same method

    returns

    The LightGBM Booster.

    Definition Classes
    LightGBMModelParams
  34. def getNativeModel(): String

    Gets the native model serialized representation as a string.

  35. def getNumIterations: Int
    Definition Classes
    LightGBMModelParams
  36. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  37. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  38. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  39. def getSparseFeatureShaps(size: Int, indices: Array[Int], values: Array[Double]): Array[Double]

    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.

  40. def getStartIteration: Int
    Definition Classes
    LightGBMModelParams
  41. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  42. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  45. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  49. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  50. val lightGBMBooster: LightGBMBoosterParam
    Definition Classes
    LightGBMModelParams
  51. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  52. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  59. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  64. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  65. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  66. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. val numIterations: IntParam
    Definition Classes
    LightGBMModelParams
  69. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  70. def predictLeaf(features: Vector): Vector

    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
  71. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  72. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  73. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  74. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  75. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  76. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  77. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  78. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  79. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  80. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  81. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  82. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  83. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  84. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  85. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  86. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  87. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  88. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  89. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  90. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  91. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  92. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  93. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  94. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  95. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  96. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  97. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  98. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  99. def saveNativeModel(filename: String, overwrite: Boolean): Unit

    Saves the native model serialized representation to file.

    Saves the native model serialized representation to file.

    filename

    The name of the file to save the model to

    overwrite

    Whether to overwrite if the file already exists

  100. final def set(paramPair: ParamPair[_]): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set(param: String, value: Any): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  102. final def set[T](param: Param[T], value: T): LightGBMModelMethods.this.type
    Definition Classes
    Params
  103. final def setDefault(paramPairs: ParamPair[_]*): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  104. final def setDefault[T](param: Param[T], value: T): LightGBMModelMethods.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  105. def setLightGBMBooster(value: LightGBMBooster): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  106. def setNumIterations(value: Int): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  107. def setStartIteration(value: Int): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  108. val startIteration: IntParam
    Definition Classes
    LightGBMModelParams
  109. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  110. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  111. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  112. def updateBoosterParamsBeforePredict(): Unit
    Attributes
    protected
  113. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Logging

Inherited from LightGBMModelParams

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped