Packages

t

ai.catboost.spark.params

TrainingParamsTrait

trait TrainingParamsTrait extends QuantizationParamsTrait with HasLabelCol with HasFeaturesCol with HasWeightCol

Params for training CatBoost. See documentation on https://catboost.ai/docs/ for details.

Linear Supertypes
HasWeightCol, HasFeaturesCol, HasLabelCol, QuantizationParamsTrait, ThreadCountParams, IgnoredFeaturesParams, Params, Serializable, Identifiable, AnyRef, Any
Known Subclasses
CatBoostClassifier, CatBoostRegressor, ClassifierTrainingParamsTrait, RegressorTrainingParamsTrait
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TrainingParamsTrait
  2. HasWeightCol
  3. HasFeaturesCol
  4. HasLabelCol
  5. QuantizationParamsTrait
  6. ThreadCountParams
  7. IgnoredFeaturesParams
  8. Params
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 val allowConstLabel: BooleanParam
  6. final val allowWritingFiles: BooleanParam
  7. final val approxOnFullHistory: BooleanParam
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final val baggingTemperature: FloatParam
  10. final val bestModelMinTrees: IntParam
  11. final val bootstrapType: EnumParam[EBootstrapType]
  12. final val borderCount: IntParam
    Definition Classes
    QuantizationParamsTrait
  13. final def clear(param: Param[_]): TrainingParamsTrait.this.type
    Definition Classes
    Params
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  15. final val connectTimeout: DurationParam
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. final val customMetric: StringArrayParam
  18. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final val depth: IntParam
  20. final val diffusionTemperature: FloatParam
  21. final val earlyStoppingRounds: IntParam
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. final val evalMetric: Param[String]
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  27. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  28. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  29. final val featureBorderType: EnumParam[EBorderSelectionType]
    Definition Classes
    QuantizationParamsTrait
  30. final val featureWeightsList: DoubleArrayParam
  31. final val featureWeightsMap: OrderedStringMapParam[Double]
  32. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  33. final val firstFeatureUsePenaltiesList: DoubleArrayParam
  34. final val firstFeatureUsePenaltiesMap: OrderedStringMapParam[Double]
  35. final val foldLenMultiplier: FloatParam
  36. final val foldPermutationBlock: IntParam
  37. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  38. final def getAllowConstLabel: Boolean
  39. final def getAllowWritingFiles: Boolean
  40. final def getApproxOnFullHistory: Boolean
  41. final def getBaggingTemperature: Float
  42. final def getBestModelMinTrees: Int
  43. final def getBootstrapType: EBootstrapType
  44. final def getBorderCount: Int
    Definition Classes
    QuantizationParamsTrait
  45. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  46. final def getConnectTimeout: Duration
  47. final def getCustomMetric: Array[String]
  48. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. final def getDepth: Int
  50. final def getDiffusionTemperature: Float
  51. final def getEarlyStoppingRounds: Int
  52. final def getEvalMetric: String
  53. final def getFeatureBorderType: EBorderSelectionType
    Definition Classes
    QuantizationParamsTrait
  54. final def getFeatureWeightsList: Array[Double]
  55. final def getFeatureWeightsMap: LinkedHashMap[String, Double]
  56. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  57. final def getFirstFeatureUsePenaltiesList: Array[Double]
  58. final def getFirstFeatureUsePenaltiesMap: LinkedHashMap[String, Double]
  59. final def getFoldLenMultiplier: Float
  60. final def getFoldPermutationBlock: Int
  61. final def getHasTime: Boolean
  62. final def getIgnoredFeaturesIndices: Array[Int]
    Definition Classes
    IgnoredFeaturesParams
  63. final def getIgnoredFeaturesNames: Array[String]
    Definition Classes
    IgnoredFeaturesParams
  64. final def getInputBorders: String
    Definition Classes
    QuantizationParamsTrait
  65. final def getIterations: Int
  66. final def getL2LeafReg: Float
  67. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  68. final def getLeafEstimationBacktracking: ELeavesEstimationStepBacktracking
  69. final def getLeafEstimationIterations: Int
  70. final def getLeafEstimationMethod: ELeavesEstimation
  71. final def getLearningRate: Float
  72. final def getLoggingLevel: ELoggingLevel
  73. final def getLossFunction: String
  74. final def getMetricPeriod: Int
  75. final def getModelShrinkMode: EModelShrinkMode
  76. final def getModelShrinkRate: Float
  77. final def getMvsReg: Float
  78. final def getNanMode: ENanMode
    Definition Classes
    QuantizationParamsTrait
  79. final def getOdPval: Float
  80. final def getOdType: EOverfittingDetectorType
  81. final def getOdWait: Int
  82. final def getOneHotMaxSize: Int
  83. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  84. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  85. final def getPenaltiesCoefficient: Float
  86. final def getPerFloatFeatureQuantizaton: Array[String]
    Definition Classes
    QuantizationParamsTrait
  87. final def getPerObjectFeaturePenaltiesList: Array[Double]
  88. final def getPerObjectFeaturePenaltiesMap: LinkedHashMap[String, Double]
  89. final def getRandomSeed: Int
  90. final def getRandomStrength: Float
  91. final def getRsm: Float
  92. final def getSamplingFrequency: ESamplingFrequency
  93. final def getSamplingUnit: ESamplingUnit
  94. final def getSaveSnapshot: Boolean
  95. final def getScoreFunction: EScoreFunction
  96. final def getSnapshotFile: String
  97. final def getSnapshotInterval: Duration
  98. final def getSparkPartitionCount: Int
  99. final def getSubsample: Float
  100. final def getThreadCount: Int
    Definition Classes
    ThreadCountParams
  101. final def getTrainDir: String
  102. final def getTrainingDriverListeningPort: Int
  103. final def getUseBestModel: Boolean
  104. final def getWeightCol: String
    Definition Classes
    HasWeightCol
  105. final def getWorkerInitializationTimeout: Duration
  106. final def getWorkerListeningPort: Int
  107. final def getWorkerMaxFailures: Int
  108. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  109. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  110. final val hasTime: BooleanParam
  111. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  112. final val ignoredFeaturesIndices: IntArrayParam
    Definition Classes
    IgnoredFeaturesParams
  113. final val ignoredFeaturesNames: StringArrayParam
    Definition Classes
    IgnoredFeaturesParams
  114. final val inputBorders: Param[String]
    Definition Classes
    QuantizationParamsTrait
  115. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  116. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  117. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  118. final val iterations: IntParam
  119. final val l2LeafReg: FloatParam
  120. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  121. final val leafEstimationBacktracking: EnumParam[ELeavesEstimationStepBacktracking]
  122. final val leafEstimationIterations: IntParam
  123. final val leafEstimationMethod: EnumParam[ELeavesEstimation]
  124. final val learningRate: FloatParam
  125. final val loggingLevel: EnumParam[ELoggingLevel]
  126. final val lossFunction: Param[String]
  127. final val metricPeriod: IntParam
  128. final val modelShrinkMode: EnumParam[EModelShrinkMode]
  129. final val modelShrinkRate: FloatParam
  130. final val mvsReg: FloatParam
  131. final val nanMode: EnumParam[ENanMode]
    Definition Classes
    QuantizationParamsTrait
  132. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  133. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  134. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  135. final val odPval: FloatParam
  136. final val odType: EnumParam[EOverfittingDetectorType]
  137. final val odWait: IntParam
  138. final val oneHotMaxSize: IntParam
  139. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  140. final val penaltiesCoefficient: FloatParam
  141. final val perFloatFeatureQuantizaton: StringArrayParam
    Definition Classes
    QuantizationParamsTrait
  142. final val perObjectFeaturePenaltiesList: DoubleArrayParam
  143. final val perObjectFeaturePenaltiesMap: OrderedStringMapParam[Double]
  144. final val randomSeed: IntParam
  145. final val randomStrength: FloatParam
  146. final val rsm: FloatParam
  147. final val samplingFrequency: EnumParam[ESamplingFrequency]
  148. final val samplingUnit: EnumParam[ESamplingUnit]
  149. final val saveSnapshot: BooleanParam
  150. final val scoreFunction: EnumParam[EScoreFunction]
  151. final def set(paramPair: ParamPair[_]): TrainingParamsTrait.this.type
    Attributes
    protected
    Definition Classes
    Params
  152. final def set(param: String, value: Any): TrainingParamsTrait.this.type
    Attributes
    protected
    Definition Classes
    Params
  153. final def set[T](param: Param[T], value: T): TrainingParamsTrait.this.type
    Definition Classes
    Params
  154. final def setAllowConstLabel(value: Boolean): TrainingParamsTrait.this.type
  155. final def setAllowWritingFiles(value: Boolean): TrainingParamsTrait.this.type
  156. final def setApproxOnFullHistory(value: Boolean): TrainingParamsTrait.this.type
  157. final def setBaggingTemperature(value: Float): TrainingParamsTrait.this.type
  158. final def setBestModelMinTrees(value: Int): TrainingParamsTrait.this.type
  159. final def setBootstrapType(value: EBootstrapType): TrainingParamsTrait.this.type
  160. final def setBorderCount(value: Int): TrainingParamsTrait.this.type
    Definition Classes
    QuantizationParamsTrait
  161. final def setConnectTimeout(value: Duration): TrainingParamsTrait.this.type
  162. final def setCustomMetric(value: Array[String]): TrainingParamsTrait.this.type
  163. final def setDefault(paramPairs: ParamPair[_]*): TrainingParamsTrait.this.type
    Attributes
    protected
    Definition Classes
    Params
  164. final def setDefault[T](param: Param[T], value: T): TrainingParamsTrait.this.type
    Attributes
    protected[ml]
    Definition Classes
    Params
  165. final def setDepth(value: Int): TrainingParamsTrait.this.type
  166. final def setDiffusionTemperature(value: Float): TrainingParamsTrait.this.type
  167. final def setEarlyStoppingRounds(value: Int): TrainingParamsTrait.this.type
  168. final def setEvalMetric(value: String): TrainingParamsTrait.this.type
  169. final def setFeatureBorderType(value: EBorderSelectionType): TrainingParamsTrait.this.type
    Definition Classes
    QuantizationParamsTrait
  170. final def setFeatureWeightsList(value: Array[Double]): TrainingParamsTrait.this.type
  171. final def setFeatureWeightsMap(value: LinkedHashMap[String, Double]): TrainingParamsTrait.this.type
  172. final def setFirstFeatureUsePenaltiesList(value: Array[Double]): TrainingParamsTrait.this.type
  173. final def setFirstFeatureUsePenaltiesMap(value: LinkedHashMap[String, Double]): TrainingParamsTrait.this.type
  174. final def setFoldLenMultiplier(value: Float): TrainingParamsTrait.this.type
  175. final def setFoldPermutationBlock(value: Int): TrainingParamsTrait.this.type
  176. final def setHasTime(value: Boolean): TrainingParamsTrait.this.type
  177. final def setIgnoredFeaturesIndices(value: Array[Int]): TrainingParamsTrait.this.type
    Definition Classes
    IgnoredFeaturesParams
  178. final def setIgnoredFeaturesNames(value: Array[String]): TrainingParamsTrait.this.type
    Definition Classes
    IgnoredFeaturesParams
  179. final def setInputBorders(value: String): TrainingParamsTrait.this.type
    Definition Classes
    QuantizationParamsTrait
  180. final def setIterations(value: Int): TrainingParamsTrait.this.type
  181. final def setL2LeafReg(value: Float): TrainingParamsTrait.this.type
  182. final def setLeafEstimationBacktracking(value: ELeavesEstimationStepBacktracking): TrainingParamsTrait.this.type
  183. final def setLeafEstimationIterations(value: Int): TrainingParamsTrait.this.type
  184. final def setLeafEstimationMethod(value: ELeavesEstimation): TrainingParamsTrait.this.type
  185. final def setLearningRate(value: Float): TrainingParamsTrait.this.type
  186. final def setLoggingLevel(value: ELoggingLevel): TrainingParamsTrait.this.type
  187. final def setLossFunction(value: String): TrainingParamsTrait.this.type
  188. final def setMetricPeriod(value: Int): TrainingParamsTrait.this.type
  189. final def setModelShrinkMode(value: EModelShrinkMode): TrainingParamsTrait.this.type
  190. final def setModelShrinkRate(value: Float): TrainingParamsTrait.this.type
  191. final def setMvsReg(value: Float): TrainingParamsTrait.this.type
  192. final def setNanMode(value: ENanMode): TrainingParamsTrait.this.type
    Definition Classes
    QuantizationParamsTrait
  193. final def setOdPval(value: Float): TrainingParamsTrait.this.type
  194. final def setOdType(value: EOverfittingDetectorType): TrainingParamsTrait.this.type
  195. final def setOdWait(value: Int): TrainingParamsTrait.this.type
  196. final def setOneHotMaxSize(value: Int): TrainingParamsTrait.this.type
  197. final def setPenaltiesCoefficient(value: Float): TrainingParamsTrait.this.type
  198. final def setPerFloatFeatureQuantizaton(value: Array[String]): TrainingParamsTrait.this.type
    Definition Classes
    QuantizationParamsTrait
  199. final def setPerObjectFeaturePenaltiesList(value: Array[Double]): TrainingParamsTrait.this.type
  200. final def setPerObjectFeaturePenaltiesMap(value: LinkedHashMap[String, Double]): TrainingParamsTrait.this.type
  201. final def setRandomSeed(value: Int): TrainingParamsTrait.this.type
  202. final def setRandomStrength(value: Float): TrainingParamsTrait.this.type
  203. final def setRsm(value: Float): TrainingParamsTrait.this.type
  204. final def setSamplingFrequency(value: ESamplingFrequency): TrainingParamsTrait.this.type
  205. final def setSamplingUnit(value: ESamplingUnit): TrainingParamsTrait.this.type
  206. final def setSaveSnapshot(value: Boolean): TrainingParamsTrait.this.type
  207. final def setScoreFunction(value: EScoreFunction): TrainingParamsTrait.this.type
  208. final def setSnapshotFile(value: String): TrainingParamsTrait.this.type
  209. final def setSnapshotInterval(value: Duration): TrainingParamsTrait.this.type
  210. final def setSparkPartitionCount(value: Int): TrainingParamsTrait.this.type
  211. final def setSubsample(value: Float): TrainingParamsTrait.this.type
  212. final def setThreadCount(value: Int): TrainingParamsTrait.this.type
    Definition Classes
    ThreadCountParams
  213. final def setTrainDir(value: String): TrainingParamsTrait.this.type
  214. final def setTrainingDriverListeningPort(value: Int): TrainingParamsTrait.this.type
  215. final def setUseBestModel(value: Boolean): TrainingParamsTrait.this.type
  216. final def setWorkerInitializationTimeout(value: Duration): TrainingParamsTrait.this.type
  217. final def setWorkerListeningPort(value: Int): TrainingParamsTrait.this.type
  218. final def setWorkerMaxFailures(value: Int): TrainingParamsTrait.this.type
  219. final val snapshotFile: Param[String]
  220. final val snapshotInterval: DurationParam
  221. final val sparkPartitionCount: IntParam
  222. final val subsample: FloatParam
  223. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  224. final val threadCount: IntParam
    Definition Classes
    ThreadCountParams
  225. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  226. final val trainDir: Param[String]
  227. final val trainingDriverListeningPort: IntParam
  228. final val useBestModel: BooleanParam
  229. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  230. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  231. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  232. final val weightCol: Param[String]
    Definition Classes
    HasWeightCol
  233. final val workerInitializationTimeout: DurationParam
  234. final val workerListeningPort: IntParam
  235. final val workerMaxFailures: IntParam

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasWeightCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from QuantizationParamsTrait

Inherited from ThreadCountParams

Inherited from IgnoredFeaturesParams

Inherited from Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped