Class/Object

ai.catboost.spark

CatBoostClassificationModel

Related Docs: object CatBoostClassificationModel | package spark

Permalink

class CatBoostClassificationModel extends ProbabilisticClassificationModel[Vector, CatBoostClassificationModel] with CatBoostModelTrait[CatBoostClassificationModel]

Classification model trained by CatBoost. Use CatBoostClassifier to train it

Serialization

Supports standard Spark MLLib serialization. Data can be saved to distributed filesystem like HDFS or local files. When saved to path two files are created: -<path>/metadata which contains Spark-specific metadata in JSON format -<path>/model which contains model in usual CatBoost format which can be read using other local CatBoost APIs (if stored in a distributed filesystem it has to be copied to the local filesystem first).

Examples:

  1. Load model

    val dataFrameForPrediction : DataFrame = ... init DataFrame ...
val path = "/home/user/catboost_spark_models/model0"
val model = CatBoostClassificationModel.load(path)
val predictions = model.transform(dataFrameForPrediction)
predictions.show()
    2. ,

  2. Save model

    val trainPool : Pool = ... init Pool ...
val classifier = new CatBoostClassifier
val model = classifier.fit(trainPool)
val path = "/home/user/catboost_spark_models/model0"
model.write.save(path)
Linear Supertypes
CatBoostModelTrait[CatBoostClassificationModel], MLWritable, ProbabilisticClassificationModel[Vector, CatBoostClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, ClassificationModel[Vector, CatBoostClassificationModel], ClassifierParams, HasRawPredictionCol, PredictionModel[Vector, CatBoostClassificationModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Model[CatBoostClassificationModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CatBoostClassificationModel
  2. CatBoostModelTrait
  3. MLWritable
  4. ProbabilisticClassificationModel
  5. ProbabilisticClassifierParams
  6. HasThresholds
  7. HasProbabilityCol
  8. ClassificationModel
  9. ClassifierParams
  10. HasRawPredictionCol
  11. PredictionModel
  12. PredictorParams
  13. HasPredictionCol
  14. HasFeaturesCol
  15. HasLabelCol
  16. Model
  17. Transformer
  18. PipelineStage
  19. Logging
  20. Params
  21. Serializable
  22. Serializable
  23. Identifiable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CatBoostClassificationModel(nativeModel: TFullModel)

    Permalink

  2. new CatBoostClassificationModel(uid: String, nativeModel: TFullModel = null, nativeDimension: 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[_]): CatBoostClassificationModel.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): CatBoostClassificationModel

    Permalink
    Definition Classes
    CatBoostClassificationModel → 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. def getAdditionalColumnsForApply: Seq[StructField]

    Permalink
    Attributes
    protected
    Definition Classes
    CatBoostClassificationModel → CatBoostModelTrait

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  24. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol

  25. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  28. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol

  29. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol

  30. final def getRawPredictionCol: String

    Permalink
    Definition Classes
    HasRawPredictionCol

  31. def getResultIteratorForApply(rawObjectsDataProvider: SWIGTYPE_p_NCB__TRawObjectsDataProviderPtr, dstRows: ArrayBuffer[Array[Any]], threadCountForTask: Int): Iterator[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    CatBoostClassificationModel → CatBoostModelTrait

  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. var nativeDimension: Int

    Permalink
    Attributes
    protected
    Definition Classes
    CatBoostClassificationModel → CatBoostModelTrait

  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
    CatBoostClassificationModel → ClassificationModel

  61. def numFeatures: Int

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

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

    Permalink
    Definition Classes
    Params

  63. var parent: Estimator[CatBoostClassificationModel]

    Permalink
    Definition Classes
    Model

  64. def predict(features: Vector): Double

    Permalink
    Definition Classes
    ClassificationModel → PredictionModel

  65. def predictProbability(features: Vector): Vector

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel

  66. def predictRaw(features: Vector): Vector

    Permalink

    Prefer batch computations operating on datasets as a whole for efficiency

    Prefer batch computations operating on datasets as a whole for efficiency

    Attributes
    protected
    Definition Classes
    CatBoostClassificationModel → ClassificationModel

  67. final def predictRawImpl(features: Vector): Array[Double]

    Permalink

    Prefer batch computations operating on datasets as a whole for efficiency

    Prefer batch computations operating on datasets as a whole for efficiency

    Definition Classes
    CatBoostModelTrait

  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

    Prefer batch computations operating on datasets as a whole for efficiency

    Prefer batch computations operating on datasets as a whole for efficiency

    Attributes
    protected
    Definition Classes
    CatBoostClassificationModel → 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. final def set(paramPair: ParamPair[_]): CatBoostClassificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  77. final def set(param: String, value: Any): CatBoostClassificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  79. final def setDefault(paramPairs: ParamPair[_]*): CatBoostClassificationModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  81. def setFeaturesCol(value: String): CatBoostClassificationModel

    Permalink
    Definition Classes
    PredictionModel

  82. def setParent(parent: Estimator[CatBoostClassificationModel]): CatBoostClassificationModel

    Permalink
    Definition Classes
    Model

  83. def setPredictionCol(value: String): CatBoostClassificationModel

    Permalink
    Definition Classes
    PredictionModel

  84. def setProbabilityCol(value: String): CatBoostClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel

  85. def setRawPredictionCol(value: String): CatBoostClassificationModel

    Permalink
    Definition Classes
    ClassificationModel

  86. def setThresholds(value: Array[Double]): CatBoostClassificationModel

    Permalink
    Definition Classes
    ProbabilisticClassificationModel

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

    Permalink
    Definition Classes
    AnyRef

  88. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds

  89. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  90. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    CatBoostClassificationModel → ProbabilisticClassificationModel → ClassificationModel → PredictionModel → Transformer

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

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

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

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

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

    Permalink
    Definition Classes
    CatBoostModelTrait → PredictionModel

  94. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PredictionModel → PipelineStage

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  96. val uid: String

    Permalink
    Definition Classes
    CatBoostClassificationModel → Identifiable

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

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams

  98. final def wait(): Unit

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

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

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

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

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

  101. def write: MLWriter

    Permalink
    Definition Classes
    CatBoostModelTrait → MLWritable

Inherited from CatBoostModelTrait[CatBoostClassificationModel]

Inherited from MLWritable

Inherited from ProbabilisticClassificationModel[Vector, CatBoostClassificationModel]

Inherited from ProbabilisticClassifierParams

Inherited from HasThresholds

Inherited from HasProbabilityCol

Inherited from ClassificationModel[Vector, CatBoostClassificationModel]

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from PredictionModel[Vector, CatBoostClassificationModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Model[CatBoostClassificationModel]

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