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, DotnetWrappable, 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. DotnetWrappable
  6. RWrappable
  7. PythonWrappable
  8. BaseWrappable
  9. Params
  10. Serializable
  11. Serializable
  12. Identifiable
  13. AnyRef
  14. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  14. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  15. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  16. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  17. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  18. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  33. def explainParams(): String
    Definition Classes
    Params
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. 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
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. 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.

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

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

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

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

  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. 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.

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

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

  49. def getLightGBMBooster: LightGBMBooster
    Definition Classes
    LightGBMModelParams
  50. def getModel: LightGBMBooster

    Alias for same method

    Alias for same method

    returns

    The LightGBM Booster.

    Definition Classes
    LightGBMModelParams
  51. def getNativeModel(): String

    Gets the native model serialized representation as a string.

  52. def getNumIterations: Int
    Definition Classes
    LightGBMModelParams
  53. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  54. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  55. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  56. 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.

  57. def getStartIteration: Int
    Definition Classes
    LightGBMModelParams
  58. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  59. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  60. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  66. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  67. val lightGBMBooster: LightGBMBoosterParam
    Definition Classes
    LightGBMModelParams
  68. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  69. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  76. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  81. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  82. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  83. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. val numIterations: IntParam
    Definition Classes
    LightGBMModelParams
  87. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  88. 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
  89. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  90. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  91. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  92. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  93. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  94. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  95. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  96. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  97. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  98. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  99. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  100. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  101. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  102. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  103. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  104. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  105. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  106. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  107. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  108. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  109. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  110. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  111. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  112. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  113. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  114. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  115. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  116. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  117. 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

  118. final def set(paramPair: ParamPair[_]): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  119. final def set(param: String, value: Any): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  120. final def set[T](param: Param[T], value: T): LightGBMModelMethods.this.type
    Definition Classes
    Params
  121. final def setDefault(paramPairs: ParamPair[_]*): LightGBMModelMethods.this.type
    Attributes
    protected
    Definition Classes
    Params
  122. final def setDefault[T](param: Param[T], value: T): LightGBMModelMethods.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  123. def setLightGBMBooster(value: LightGBMBooster): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  124. def setNumIterations(value: Int): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  125. def setStartIteration(value: Int): LightGBMModelMethods.this.type
    Definition Classes
    LightGBMModelParams
  126. val startIteration: IntParam
    Definition Classes
    LightGBMModelParams
  127. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  128. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  129. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  130. def updateBoosterParamsBeforePredict(): Unit
    Attributes
    protected
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Logging

Inherited from LightGBMModelParams

Inherited from Wrappable

Inherited from DotnetWrappable

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