Quick start - CatBoost. Documentation

CatBoost

Contents

Overview of CatBoost

Python package

R package

Command-line version

Applying models

Objectives and metrics

Data format description

Parameter tuning

Speeding up the training

Data visualization

Educational materials

Development and contributions

Algorithm details

Training parameters

CatBoostClassifier

CatBoostRegressor

MetricVisualizer

Text processing

Overview of CatBoost

Python package installation

Build from source on Linux and macOS

Build from source on Windows

Build a wheel package

Additional packages for data visualization support

R package installation

Install the released version

Build from source

Install from a local copy on Linux and macOS

Install from a local copy on Windows

Command-line version binary

Build the binary from a local copy on Linux and macOS

Build the binary from a local copy on Windows

Build the binary with make on Linux (CPU only)

Build the binary with MPI support from a local copy (GPU only)

Python package

Training parameters

calc_leaf_indexes

calc_feature_statistics

get_best_iteration

get_evals_result

get_feature_importance

get_object_importance

get_scale_and_bias

plot_predictions

randomized_search

select_features

set_scale_and_bias

set_feature_names

virtual_ensembles_predict

CatBoostClassifier

calc_leaf_indexes

calc_feature_statistics

get_best_iteration

get_evals_result

get_feature_importance

get_object_importance

get_scale_and_bias

plot_predictions

randomized_search

select_features

set_feature_names

set_scale_and_bias

staged_predict_proba

CatBoostRegressor

calc_leaf_indexes

calc_feature_statistics

get_best_iteration

get_evals_result

get_feature_importance

get_object_importance

get_scale_and_bias

plot_predictions

randomized_search

select_features

set_feature_names

set_scale_and_bias

rotten_tomatoes

get_cat_feature_count

get_feature_count

get_feature_names

get_num_feature_count

get_object_count

MetricVisualizer

get_cat_feature_indices

get_text_feature_indices

save_quantization_borders

set_feature_names

set_group_weight

set_pairs_weight

set_subgroup_id

Pool initialization

Text processing

unknown_token_id

end_of_sentence_token_id

min_unused_token_id

get_confusion_matrix

get_gpu_device_count

select_threshold

R package

catboost.load_pool

catboost.save_pool

catboost.load_model

catboost.save_model

catboost.predict

catboost.shrink

catboost.staged_predict

catboost.get_feature_importance

catboost.get_object_importance

catboost.get_model_params

Training parameters

Command-line version

Cross-validation

Calculate metrics

Calculate feature importance

Calculate object importance

Metadata manipulation

Select features

Applying models

C/C++

Evaluation library

Standalone evaluator

getPredictionDimension

getUsedCategoricFeatureCount

getUsedNumericFeatureCount

CatBoostPredictions

copyRowMajorPredictions

copyObjectPredictions

getPredictionDimension

Models exported as code

Objectives and metrics

Variables used in formulas

Multiregression

Multiclassification

Feature importance

Feature analysis charts

Feature interaction

Object importance

Data format description

Columns description

Dataset description in delimiter-separated values format

Dataset description in extended libsvm format

Pairs description

Custom quantization borders and missing value modes

Feature analysis

Feature importance

Feature interaction strength