ai.catboost

Class CatBoostModel

java.lang.Object

ai.catboost.CatBoostModel

All Implemented Interfaces:

AutoCloseable

public class CatBoostModel
extends Object
implements AutoCloseable

CatBoost model, supports basic model application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatBoostModel.CatFeature
static class	CatBoostModel.EmbeddingFeature
static class	CatBoostModel.Feature
static class	CatBoostModel.FloatFeature
static class	CatBoostModel.FormulaEvaluatorType
static class	CatBoostModel.TextFeature

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
String[]	getFeatureNames()
List<CatBoostModel.Feature>	getFeatures()
Map<String,String>	getMetadata()
int	getPredictionDimension()
int	getTreeCount()
int	getUsedCategoricFeatureCount()
int	getUsedEmbeddingFeatureCount()
int	getUsedNumericFeatureCount()
int	getUsedTextFeatureCount()
static CatBoostModel	loadModel(InputStream in) Load CatBoost model from stream.
static CatBoostModel	loadModel(InputStream in, String modelFormat) Load CatBoost model from stream.
static CatBoostModel	loadModel(String modelPath) Load CatBoost model from file modelPath.
static CatBoostModel	loadModel(String modelPath, String modelFormat) Load CatBoost model from file modelPath.
CatBoostPredictions	predict(float[][] numericFeatures, int[][] catFeatureHashes) Same as predict(float[][], String[][], CatBoostPredictions), but returns predictions instead of taking it as the last parameter.
void	predict(float[][] numericFeatures, int[][] catFeatureHashes, CatBoostPredictions prediction) Same as predict(float[][], String[][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).
CatBoostPredictions	predict(float[][] numericFeatures, int[][] catFeatureHashes, String[][] textFeatures, float[][][] embeddingFeatures) Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but returns predictions instead of taking it as the last parameter.
void	predict(float[][] numericFeatures, int[][] catFeatureHashes, String[][] textFeatures, float[][][] embeddingFeatures, CatBoostPredictions prediction) Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).
CatBoostPredictions	predict(float[][] numericFeatures, String[][] catFeatures) Same as predict(float[][], String[][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.
void	predict(float[][] numericFeatures, String[][] catFeatures, CatBoostPredictions prediction) Apply model to a batch of objects.
CatBoostPredictions	predict(float[][] numericFeatures, String[][] catFeatures, String[][] textFeatures, float[][][] embeddingFeatures) Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.
void	predict(float[][] numericFeatures, String[][] catFeatures, String[][] textFeatures, float[][][] embeddingFeatures, CatBoostPredictions prediction) Apply model to a batch of objects.
CatBoostPredictions	predict(float[] numericFeatures, int[] catFeatureHashes) Same as predict(float[], int[], CatBoostPredictions), but returns prediction instead of taking it as third parameter.
void	predict(float[] numericFeatures, int[] catFeatureHashes, CatBoostPredictions prediction) Same as predict(float[], String[], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).
CatBoostPredictions	predict(float[] numericFeatures, int[] catFeatureHashes, String[] textFeatures, float[][] embeddingFeatures) Same as predict(float[], int[], String[], float[][], CatBoostPredictions), but returns prediction instead of taking it as third parameter.
void	predict(float[] numericFeatures, int[] catFeatureHashes, String[] textFeatures, float[][] embeddingFeatures, CatBoostPredictions prediction) Same as predict(float[], String[], String[], float[][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).
CatBoostPredictions	predict(float[] numericFeatures, String[] catFeatures) Same as predict(float[], String[], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.
void	predict(float[] numericFeatures, String[] catFeatures, CatBoostPredictions prediction) Apply model to object defined by features.
CatBoostPredictions	predict(float[] numericFeatures, String[] catFeatures, String[] textFeatures, float[][] embeddingFeatures) Same as predict(float[], String[], String[], float[][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.
void	predict(float[] numericFeatures, String[] catFeatures, String[] textFeatures, float[][] embeddingFeatures, CatBoostPredictions prediction) Apply model to object defined by features.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadModel

@NotNull
public static CatBoostModel loadModel(@NotNull
                                               String modelPath)
                                        throws ai.catboost.CatBoostError

Load CatBoost model from file modelPath.

Parameters:

modelPath - Path to the model.

Returns:

CatBoost model.

Throws:

CatBoostError - When failed to load model.

loadModel

@NotNull
public static CatBoostModel loadModel(@NotNull
                                               String modelPath,
                                               @NotNull
                                               String modelFormat)
                                        throws ai.catboost.CatBoostError

Load CatBoost model from file modelPath.

Parameters:

modelPath - Path to the model.

modelFormat - Model file format (bin or json)

Returns:

CatBoost model.

Throws:

CatBoostError - When failed to load model.

loadModel

@NotNull
public static CatBoostModel loadModel(InputStream in)
                                        throws ai.catboost.CatBoostError,
                                               IOException

Load CatBoost model from stream.

Parameters:

in - Input stream containing model.

Returns:

CatBoost model.

Throws:

CatBoostError - When failed to load model.

IOException - When failed to read model from file.

loadModel

@NotNull
public static CatBoostModel loadModel(InputStream in,
                                               @NotNull
                                               String modelFormat)
                                        throws ai.catboost.CatBoostError,
                                               IOException

Load CatBoost model from stream.

Parameters:

in - Input stream containing model.

modelFormat - Model file format (bin or json)

Returns:

CatBoost model.

Throws:

CatBoostError - When failed to load model.

IOException - When failed to read model from file.

getPredictionDimension

public int getPredictionDimension()

Returns:

Dimension of model prediction.

getTreeCount

public int getTreeCount()

Returns:

Number of trees in model.

getUsedNumericFeatureCount

public int getUsedNumericFeatureCount()

Returns:

Number of numeric features used by the model.

getUsedCategoricFeatureCount

public int getUsedCategoricFeatureCount()

Returns:

Number of categorical features used by the model.

getUsedTextFeatureCount

public int getUsedTextFeatureCount()

Returns:

Number of text features used by the model.

getUsedEmbeddingFeatureCount

public int getUsedEmbeddingFeatureCount()

Returns:

Number of embedding features used by the model.

getFeatureNames

public String[] getFeatureNames()

Returns:

Names of features used by the model.

getMetadata

public Map<String,String> getMetadata()

Returns:

A map of metadata

getFeatures

public List<CatBoostModel.Feature> getFeatures()

Returns:

A list of feature metadata, sorted by flat index.

predict

public void predict(@Nullable
                    float[] numericFeatures,
                    @Nullable
                    String[] catFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Apply model to object defined by features.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[] numericFeatures,
                    @Nullable
                    String[] catFeatures,
                    @Nullable
                    String[] textFeatures,
                    @Nullable
                    float[][] embeddingFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Apply model to object defined by features.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

textFeatures - Text features.

embeddingFeatures - Embedding features.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[] numericFeatures,
                                            @Nullable
                                            String[] catFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[], String[], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[] numericFeatures,
                                            @Nullable
                                            String[] catFeatures,
                                            @Nullable
                                            String[] textFeatures,
                                            @Nullable
                                            float[][] embeddingFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[], String[], String[], float[][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

textFeatures - Text features.

embeddingFeatures - Embedding features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[] numericFeatures,
                    @Nullable
                    int[] catFeatureHashes,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Same as predict(float[], String[], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[] numericFeatures,
                    @Nullable
                    int[] catFeatureHashes,
                    @Nullable
                    String[] textFeatures,
                    @Nullable
                    float[][] embeddingFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Same as predict(float[], String[], String[], float[][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

textFeatures - Text features.

embeddingFeatures - Embedding features.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[] numericFeatures,
                                            @Nullable
                                            int[] catFeatureHashes)
                                     throws ai.catboost.CatBoostError

Same as predict(float[], int[], CatBoostPredictions), but returns prediction instead of taking it as third parameter.

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[] numericFeatures,
                                            @Nullable
                                            int[] catFeatureHashes,
                                            @Nullable
                                            String[] textFeatures,
                                            @Nullable
                                            float[][] embeddingFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[], int[], String[], float[][], CatBoostPredictions), but returns prediction instead of taking it as third parameter.

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

textFeatures - Text features.

embeddingFeatures - Embedding features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[][] numericFeatures,
                    @Nullable
                    String[][] catFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Apply model to a batch of objects.

Parameters:

numericFeatures - Numeric features matrix.

catFeatures - Categoric features matrix.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[][] numericFeatures,
                    @Nullable
                    String[][] catFeatures,
                    @Nullable
                    String[][] textFeatures,
                    @Nullable
                    float[][][] embeddingFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Apply model to a batch of objects.

Parameters:

numericFeatures - Numeric features matrix.

catFeatures - Categoric features matrix.

textFeatures - Text features matrix.

embeddingFeatures - Embedding features matrix.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[][] numericFeatures,
                                            @Nullable
                                            String[][] catFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[][] numericFeatures,
                                            @Nullable
                                            String[][] catFeatures,
                                            @Nullable
                                            String[][] textFeatures,
                                            @Nullable
                                            float[][][] embeddingFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but returns prediction instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatures - Categoric features.

textFeatures - Text features.

embeddingFeatures - Embedding features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[][] numericFeatures,
                    @Nullable
                    int[][] catFeatureHashes,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

public void predict(@Nullable
                    float[][] numericFeatures,
                    @Nullable
                    int[][] catFeatureHashes,
                    @Nullable
                    String[][] textFeatures,
                    @Nullable
                    float[][][] embeddingFeatures,
                    @NotNull
                    CatBoostPredictions prediction)
             throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but accept categoric features as hashes computed by hashCategoricalFeature(String).

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

textFeatures - Text features.

embeddingFeatures - Embedding features.

prediction - Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[][] numericFeatures,
                                            @Nullable
                                            int[][] catFeatureHashes)
                                     throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], CatBoostPredictions), but returns predictions instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

predict

@NotNull
public CatBoostPredictions predict(@Nullable
                                            float[][] numericFeatures,
                                            @Nullable
                                            int[][] catFeatureHashes,
                                            @Nullable
                                            String[][] textFeatures,
                                            @Nullable
                                            float[][][] embeddingFeatures)
                                     throws ai.catboost.CatBoostError

Same as predict(float[][], String[][], String[][], float[][][], CatBoostPredictions), but returns predictions instead of taking it as the last parameter.

Parameters:

numericFeatures - Numeric features.

catFeatureHashes - Categoric feature hashes.

textFeatures - Text features.

embeddingFeatures - Embedding features.

Returns:

Model predictions.

Throws:

CatBoostError - In case of error within native library.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()
           throws ai.catboost.CatBoostError

Specified by:

close in interface AutoCloseable

Throws:

ai.catboost.CatBoostError