🕷️ Crawler Inspector

[](https://catboost.ai/ "CatBoost") - Installation - [Overview](https://catboost.ai/docs/en/concepts/en/concepts/installation) - Python package installation - CatBoost for Apache Spark installation - R package installation - Command-line version binary - Build from source - Key Features - Training parameters - Python package - [Quick start](https://catboost.ai/docs/en/concepts/en/concepts/python-quickstart) - CatBoost - CatBoostClassifier - [Overview](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier) - [fit](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_fit) - [predict](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_predict) - [predict\_proba](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_predict_proba) - [Attributes](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_attributes) - [calc\_leaf\_indexes](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboost_calc_leaf_indexes) - [calc\_feature\_statistics](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_calc_feature_statistics) - [compare](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_modelcompare) - [copy](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_copy) - [eval\_metrics](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics) - [get\_all\_params](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_all_params) - [get\_best\_iteration](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_best_iteration) - [get\_best\_score](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_best_score) - [get\_borders](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_borders) - [get\_evals\_result](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_evals_result) - [get\_feature\_importance](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_feature_importance) - [get\_metadata](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_metadata) - [get\_object\_importance](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_object_importance) - [get\_param](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_param) - [get\_params](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_params) - [get\_probability\_threshold](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_probability_threshold) - [get\_scale\_and\_bias](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_scale_and_bias) - [get\_test\_eval](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_test_eval) - [grid\_search](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_grid_search) - [is\_fitted](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_is_fitted) - [load\_model](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_load_model) - [plot\_predictions](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_plot_predictions) - [plot\_tree](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_plot_tree) - [randomized\_search](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_randomized_search) - [save\_borders](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_save_borders) - [save\_model](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_save_model) - [score](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_score) - [select\_features](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_select_features) - [set\_feature\_names](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_set_feature_names) - [set\_params](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_set_params) - [set\_probability\_threshold](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_set_probability_threshold) - [set\_scale\_and\_bias](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_set_scale_and_bias) - [shrink](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_shrink) - [staged\_predict](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_staged_predict) - [staged\_predict\_proba](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_staged_predict_proba) - CatBoostRanker - CatBoostRegressor - [cv](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_cv) - datasets - FeaturesData - MetricVisualizer - Pool - [sample\_gaussian\_process](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_sample_gaussian_process) - [sum\_models](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_sum_models) - [to\_classifier](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_to_classifier) - [to\_regressor](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_to_regressor) - [train](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_train) - Text processing - utils - [Usage examples](https://catboost.ai/docs/en/concepts/en/concepts/python-usages-examples) - CatBoost for Apache Spark - R package - Command-line version - Applying models - Objectives and metrics - Model analysis - Data format description - [Parameter tuning](https://catboost.ai/docs/en/concepts/en/concepts/parameter-tuning) - [Speeding up the training](https://catboost.ai/docs/en/concepts/en/concepts/speed-up-training) - Data visualization - Algorithm details - [FAQ](https://catboost.ai/docs/en/concepts/en/concepts/faq) - Educational materials - [Development and contributions](https://catboost.ai/docs/en/concepts/en/concepts/development-and-contributions) - [Contacts](https://catboost.ai/docs/en/concepts/en/concepts/contacts) eval\_metrics ## In this article: - [Method call format](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#call-format) - [Parameters](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#parameters) - [data](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#data) - [metrics](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#metrics) - [ntree\_start](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#ntree_start) - [ntree\_end](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#ntree_end) - [eval\_period](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#eval_period) - [thread\_count](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#thread_count) - [log\_cout](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#log_cout) - [log\_cerr](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#log_cerr) - [Type of return value](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#output-format) 1. Python package 2. [CatBoostClassifier](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier) 3. eval\_metrics # eval\_metrics - [Method call format](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#call-format) - [Parameters](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#parameters) - [data](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#data) - [metrics](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#metrics) - [ntree\_start](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#ntree_start) - [ntree\_end](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#ntree_end) - [eval\_period](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#eval_period) - [thread\_count](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#thread_count) - [log\_cout](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#log_cout) - [log\_cerr](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#log_cerr) - [Type of return value](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_eval-metrics#output-format) Calculate the specified metrics for the specified dataset. ## Method call format ``` eval_metrics(data, metrics, ntree_start=0, ntree_end=0, eval_period=1, thread_count=-1, log_cout=sys.stdout, log_cerr=sys.stderr) ``` ## Parameters ### data #### Description A file or matrix with the input dataset. **Possible values** catboost.Pool **Default value** Required parameter ### metrics #### Description The list of metrics to be calculated. [Supported metrics](https://catboost.ai/docs/en/concepts/en/references/custom-metric__supported-metrics) For example, if the AUC and Logloss metrics should be calculated, use the following construction: ``` ['Logloss', 'AUC'] ``` **Possible values** list of strings **Default value** Required parameter ### ntree\_start #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)`. This parameter defines the index of the first tree to be used when applying the model or calculating the metrics (the inclusive left border of the range). Indices are zero-based. **Possible values** int **Default value** 0 ### ntree\_end #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)` and the step of the trees to use to`eval_period`. This parameter defines the index of the first tree not to be used when applying the model or calculating the metrics (the exclusive right border of the range). Indices are zero-based. **Possible values** int **Default value** 0 (the index of the last tree to use equals to the number of trees in the model minus one) ### eval\_period #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)` and the step of the trees to use to`eval_period`. This parameter defines the step to iterate over the range `[`ntree\_start`;`ntree\_end`)`. For example, let's assume that the following parameter values are set: - `ntree_start` is set 0 - `ntree_end` is set to N (the total tree count) - `eval_period` is set to 2 In this case, the results are returned for the following tree ranges: `[0, 2)`, `[0, 4)`, ... , `[0, N)`. **Possible values** int **Default value** 1 (the trees are applied sequentially: the first tree, then the first two trees, etc.) ### thread\_count #### Description The number of threads to use for operation. Optimizes the speed of execution. This parameter doesn't affect results. **Possible values** int **Default value** \-1 (the number of threads is equal to the number of processor cores) ### log\_cout Output stream or callback for logging. **Possible types** - callable Python object - python object providing the `write()` method **Default value** sys.stdout ### log\_cerr Error stream or callback for logging. **Possible types** - callable Python object - python object providing the `write()` method **Default value** sys.stderr ## Type of return value A dictionary of calculated metrics in the following format: ``` metric -> array of shape [(ntree_end – ntree_start) / eval_period] ``` ### Was the article helpful? Yes No Previous [copy](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_copy) Next [get\_all\_params](https://catboost.ai/docs/en/concepts/en/concepts/python-reference_catboostclassifier_get_all_params) 

Calculate the specified metrics for the specified dataset. ## Method call format ``` eval_metrics(data, metrics, ntree_start=0, ntree_end=0, eval_period=1, thread_count=-1, log_cout=sys.stdout, log_cerr=sys.stderr) ``` ## Parameters ### data #### Description A file or matrix with the input dataset. **Possible values** catboost.Pool **Default value** Required parameter ### metrics #### Description The list of metrics to be calculated. [Supported metrics](https://catboost.ai/docs/en/references/custom-metric__supported-metrics) For example, if the AUC and Logloss metrics should be calculated, use the following construction: ``` ['Logloss', 'AUC'] ``` **Possible values** list of strings **Default value** Required parameter ### ntree\_start #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)`. This parameter defines the index of the first tree to be used when applying the model or calculating the metrics (the inclusive left border of the range). Indices are zero-based. **Possible values** int **Default value** 0 ### ntree\_end #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)` and the step of the trees to use to`eval_period`. This parameter defines the index of the first tree not to be used when applying the model or calculating the metrics (the exclusive right border of the range). Indices are zero-based. **Possible values** int **Default value** 0 (the index of the last tree to use equals to the number of trees in the model minus one) ### eval\_period #### Description To reduce the number of trees to use when the model is applied or the metrics are calculated, set the range of the tree indices to`[ntree_start; ntree_end)` and the step of the trees to use to`eval_period`. This parameter defines the step to iterate over the range `[`ntree\_start`;`ntree\_end`)`. For example, let's assume that the following parameter values are set: - `ntree_start` is set 0 - `ntree_end` is set to N (the total tree count) - `eval_period` is set to 2 In this case, the results are returned for the following tree ranges: `[0, 2)`, `[0, 4)`, ... , `[0, N)`. **Possible values** int **Default value** 1 (the trees are applied sequentially: the first tree, then the first two trees, etc.) ### thread\_count #### Description The number of threads to use for operation. Optimizes the speed of execution. This parameter doesn't affect results. **Possible values** int **Default value** \-1 (the number of threads is equal to the number of processor cores) ### log\_cout Output stream or callback for logging. **Possible types** - callable Python object - python object providing the `write()` method **Default value** sys.stdout ### log\_cerr Error stream or callback for logging. **Possible types** - callable Python object - python object providing the `write()` method **Default value** sys.stderr ## Type of return value A dictionary of calculated metrics in the following format: ``` metric -> array of shape [(ntree_end – ntree_start) / eval_period] ```