--- metadata: - name: generator content: Diplodoc Platform v5.50.3 alternate: - https://catboost.ai/docs/en/concepts/parameter-tuning.md --- > **Documentation Index:** Fetch the complete configuration index at https://catboost.ai/docs/en/llms.txt # Parameter tuning CatBoost provides a flexible interface for parameter tuning and can be configured to suit different tasks. This section contains some tips on the possible parameter settings. ## One-hot encoding {#one-hot-enc} {% note warning %} Do not use one-hot encoding during preprocessing. This affects both the training speed and the resulting quality. {% endnote %} Sometimes when categorical features don't have a lot of values, one-hot encoding works well. Usually one-hot encoding does not significantly improve the quality of the model. But if it is required, use the inbuilt parameters instead of preprocessing the dataset. {% cut "Parameters" %} **Command-line version parameters:** `--one-hot-max-size` **Python parameters:** `one_hot_max_size` **R parameters:** `one_hot_max_size` #### Description Use one-hot encoding for all categorical features with a number of different values less than or equal to the given parameter value. Ctrs are not calculated for such features. **Default value** The default value depends on various conditions: - N/A if training is performed on CPU in Pairwise scoring mode {% cut "Read more about Pairwise scoring" %} The following loss functions use Pairwise scoring: - YetiRankPairwise - PairLogitPairwise - QueryCrossEntropy Pairwise scoring is slightly different from regular training on pairs, since pairs are generated only internally during the training for the corresponding metrics. One-hot encoding is not available for these loss functions. {% endcut %} - 255 if training is performed on GPU and the selected Ctr types require target data that is not available during the training - 10 if training is performed in [Ranking](https://catboost.ai/docs/en/concepts/loss-functions-ranking.md) mode - 2 if none of the conditions above is met {% endcut %} ## Number of trees {#trees-number} It is recommended to check that there is no obvious underfitting or overfitting before tuning any other parameters. In order to do this it is necessary to analyze the metric value on the validation dataset and select the appropriate number of iterations. This can be done by setting the number of [iterations](https://catboost.ai/docs/en/references/training-parameters/common.md#iterations) to a large value, using the [overfitting detector](https://catboost.ai/docs/en/concepts/overfitting-detector.md) parameters and turning the [use best model](https://catboost.ai/docs/en/references/training-parameters/common.md#use_best_model) options on. In this case the resulting model contains only the first `k` best iterations, where `k` is the iteration with the best loss value on the validation dataset. Also, the metric for choosing the best model may differ from the one used for optimizing the objective value. For example, it is possible to set the optimized function to Logloss and use the AUC function for the overfitting detector. To do so, use the [evaluation metric](https://catboost.ai/docs/en/references/training-parameters/common.md#eval_metric) parameter. {% cut "Parameters" %} **Command-line version parameters:** `-i`, `--iterations` **Python parameters:** `--iterations` **R parameters:** `--iterations` #### Description The maximum number of trees that can be built when solving machine learning problems. When using other parameters that limit the number of iterations, the final number of trees may be less than the number specified in this parameter. **Command-line version parameters:** `--use-best-model` **Python parameters:** `--use-best-model` **R parameters:** `--use-best-model` #### Description If this parameter is set, the number of trees that are saved in the resulting model is defined as follows: 1. Build the number of trees defined by the training parameters. 1. Use the validation dataset to identify the iteration with the optimal value of the metric specified in  `--eval-metric` (`--eval-metric`). No trees are saved after this iteration. This option requires a validation dataset to be provided. **Command-line version parameters:** `--eval-metric` **Python parameters:** `--eval-metric` **R parameters:** `--eval-metric` #### Description The metric used for overfitting detection (if enabled) and best model selection (if enabled). Some metrics support optional parameters (see the [Objectives and metrics](https://catboost.ai/docs/en/concepts/loss-functions.md) section for details on each metric). Format: ``` [:=;..;=] ``` [Supported metrics](https://catboost.ai/docs/en/references/eval-metric__supported-metrics.md) Examples: ``` R2 ``` ``` Quantile:alpha=0.3 ``` **Command-line version parameters:** **Overfitting detection settings** **Command-line version parameters:** `--od-type` **Python parameters:** `od_type` **R parameters:** `od_type` #### Description The type of the overfitting detector to use. Possible values: - IncToDec - Iter **Command-line version parameters:** `--od-pval` **Python parameters:** `od_pval` **R parameters:** `od_pval` #### Description The threshold for the IncToDec [overfitting detector](https://catboost.ai/docs/en/concepts/overfitting-detector.md) type. The training is stopped when the specified value is reached. Requires that a validation dataset was input. For best results, it is recommended to set a value in the range $[10^{–10}; 10^{-2}]$. The larger the value, the earlier overfitting is detected. {% note alert %} Do not use this parameter with the Iter overfitting detector type. {% endnote %} **Command-line version parameters:** `--od-wait` **Python parameters:** `od_wait` **R parameters:** `od_wait` #### Description The number of iterations to continue the training after the iteration with the optimal metric value. The purpose of this parameter differs depending on the selected overfitting detector type: - IncToDec — Ignore the overfitting detector when the threshold is reached and continue learning for the specified number of iterations after the iteration with the optimal metric value. - Iter — Consider the model overfitted and stop training after the specified number of iterations since the iteration with the optimal metric value. {% endcut %} ## Learning rate {#learning-rate} This setting is used for reducing the gradient step. It affects the overall time of training: the smaller the value, the more iterations are required for training. Choose the value based on the performance expectations. By default, the learning rate is defined automatically based on the dataset properties and the number of iterations. The automatically defined value should be close to the optimal one. Possible ways of adjusting the learning rate depending on the overfitting results: - There is no overfitting on the last iterations of training (the training does not converge) — increase the learning rate. - Overfitting is detected — decrease the learning rate. {% cut "Parameters" %} **Command-line version parameters:** `-w`, `--learning-rate` **Python parameters:** `learning_rate` **R parameters:** `learning_rate` #### Description The learning rate. Used for reducing the gradient step. {% endcut %} ## Tree depth {#tree-depth} In most cases, the optimal depth ranges from 4 to 10. Values in the range from 6 to 10 are recommended. {% note info %} The maximum depth of the trees is limited to 8 for pairwise modes (YetiRank, PairLogitPairwise and QueryCrossEntropy) when the training is performed on GPU. {% endnote %} {% cut "Parameters" %} **Command-line version parameters:** `-n`, `--depth` **Python parameters:** `depth` **R parameters:** `depth` #### Description Depth of the trees. The range of supported values depends on the processing unit type and the type of the selected loss function: - CPU — Any integer up to  16. - GPU — Any integer up to 8 pairwise modes (YetiRank, PairLogitPairwise and QueryCrossEntropy) and up to   16 for all other loss functions. {% endcut %} ## L2 regularization {#l2-reg} Try different values for the regularizer to find the best possible. {% cut "Parameters" %} **Command-line version parameters:** `--l2-leaf-reg` **Python parameters:** `l2_leaf_reg` **R parameters:** `l2_leaf_reg` #### Description Coefficient at the L2 regularization term of the cost function. Any positive value is allowed. {% endcut %} ## Random strength {#rand-str} Try setting different values for the `random_strength` parameter. {% cut "Parameters" %} **Command-line version parameters:** `--random-strength` **Python parameters:** `random_strength` **R parameters:** `random_strength` #### Description The amount of randomness to use for scoring splits when the tree structure is selected. Use this parameter to avoid overfitting the model. The value of this parameter is used when selecting splits. On every iteration each possible split gets a score (for example, the score indicates how much adding this split will improve the loss function for the training dataset). The split with the highest score is selected. The scores have no randomness. A normally distributed random variable is added to the score of the feature. It has a zero mean and a variance that decreases during the training. The value of this parameter is the multiplier of the variance. {% note info %} This parameter is not supported for the following loss functions: - QueryCrossEntropy - YetiRankPairwise - PairLogitPairwise {% endnote %} {% endcut %} ## Bagging temperature {#bagg-temp} Try setting different values for the `bagging_temperature` parameter {% cut "Parameters" %} **Command-line version parameters:** `--bagging-temperature` **Python parameters:** `bagging_temperature` **R parameters:** `bagging_temperature` #### Description Defines the settings of the Bayesian bootstrap. It is used by default in classification and regression modes. Use the Bayesian bootstrap to assign random weights to objects. The weights are sampled from exponential distribution if the value of this parameter is set to 1. All weights are equal to 1 if the value of this parameter is set to 0. Possible values are in the range $[0; \inf)$. The higher the value the more aggressive the bagging is. This parameter can be used if the selected bootstrap type is Bayesian. {% endcut %} ## Border count {#border-count} The number of splits for numerical features. The default value depends on the processing unit type and other parameters: - CPU: 254 - GPU in PairLogitPairwise and YetiRankPairwise modes: 32 - GPU in all other modes: 128 The value of this parameter significantly impacts the speed of training on GPU. The smaller the value, the faster the training is performed (refer to the [Number of splits for numerical features](https://catboost.ai/docs/en/concepts/speed-up-training.md) section for details). 128 splits are enough for many datasets. However, try to set the value of this parameter to 254 when training on GPU if the best possible quality is required. The value of this parameter does not significantly impact the speed of training on CPU. Try to set it to 254 for the best possible quality. {% cut "Parameters" %} **Command-line version parameters:** `-x`, `--border-count` **Python parameters:** `border_count` _Alias:_`max_bin` **R parameters:** `border_count` #### Description Recommended values are up to 255. Larger values slow down the training. The number of splits for numerical features. Allowed values are integers from 1 to 65535 inclusively. {% endcut %} ## Internal dataset order {#internal-dataset-order} Use this option if the objects in your dataset are given in the required order. In this case, random permutations are not performed during the [Transforming categorical features to numerical features](https://catboost.ai/docs/en/concepts/algorithm-main-stages_cat-to-numberic.md) and [Choosing the tree structure](https://catboost.ai/docs/en/concepts/algorithm-main-stages_choose-tree-structure.md) stages. {% cut "Parameters" %} **Command-line version parameters:** `--has-time` **Python parameters:** `--has-time` **R parameters:** `--has-time` #### Description Use the order of objects in the input data (do not perform random permutations during the [Transforming categorical features to numerical features](https://catboost.ai/docs/en/concepts/algorithm-main-stages_cat-to-numberic.md) and [Choosing the tree structure](https://catboost.ai/docs/en/concepts/algorithm-main-stages_choose-tree-structure.md) stages). The Timestamp column type is used to determine the order of objects if specified in the [input data](https://catboost.ai/docs/en/concepts/input-data.md). {% endcut %} ## Tree growing policy {#tree-growing-policy} By default, CatBoost uses symmetric trees, which are built if the growing policy is set to SymmetricTree. Such trees are built level by level until the specified depth is reached. On each iteration, all leaves from the last tree level are split with the same condition. The resulting tree structure is always symmetric. Symmetric trees have a very good prediction speed (roughly 10 times faster than non-symmetric trees) and give better quality in many cases. However, in some cases, other tree growing strategies can give better results than growing symmetric trees. Try to analyze the results obtained with different growing trees strategies. Specifics: Symmetric trees, that are used by default, can be applied much faster (up to 10 times faster). {% cut "Parameters" %} **Command-line version parameters:** `--grow-policy` **Python parameters:** `grow_policy` **R parameters:** `grow_policy` #### Description The tree growing policy. Defines how to perform greedy tree construction. Possible values: - SymmetricTree — A tree is built level by level until the specified depth is reached. On each iteration, all leaves from the last tree level are split with the same condition. The resulting tree structure is always symmetric. - Depthwise — A tree is built level by level until the specified depth is reached. On each iteration, all non-terminal leaves from the last tree level are split. Each leaf is split by condition with the best loss improvement. {% note info %} Models with this growing policy can not be analyzed using the PredictionDiff feature importance and can be exported only to json and cbm. {% endnote %} - Lossguide — A tree is built leaf by leaf until the specified maximum number of leaves is reached. On each iteration, non-terminal leaf with the best loss improvement is split. {% note info %} Models with this growing policy can not be analyzed using the PredictionDiff feature importance and can be exported only to json and cbm. {% endnote %} **Command-line version parameters:** `--min-data-in-leaf` **Python parameters:** `min_data_in_leaf` _Alias:_`min_child_samples` **R parameters:** `min_data_in_leaf` #### Description The minimum number of training samples in a leaf. CatBoost does not search for new splits in leaves with samples count less than the specified value. Can be used only with the Lossguide and Depthwise growing policies. **Command-line version parameters:** `--max-leaves` **Python parameters:** `max_leaves` _Alias:_`num_leaves` **R parameters:** `max_leaves` #### Description The maximum number of leafs in the resulting tree. Can be used only with the Lossguide growing policy. {% note info %} It is not recommended to use values greater than 64, since it can significantly slow down the training process. {% endnote %} {% endcut %} ## Golden features {#golden-features} If the dataset has a feature, which is a strong predictor of the result, the pre-quantisation of this feature may decrease the information that the model can get from it. It is recommended to use an increased number of borders (1024) for this feature. {% note info %} An increased number of borders should not be set for all features. It is recommended to set it for one or two golden features. {% endnote %} {% list tabs %} - Command-line Parameter | Description ----- | ----- `--per-float-feature-quantization` | A semicolon separated list of quantization descriptions.
Format:
```FeatureId[:border_count=BorderCount][:nan_mode=BorderType][:border_type=border_selection_method]```| Examples: - ``` --per-float-feature-quantization 0:border_count=1024 ``` In this example, the feature indexed 0 has 1024 borders. - ``` --per-float-feature-quantization 0:border_count=1024;1:border_count=1024 ``` In this example, features indexed 0 and 1 have 1024 borders. - Python Parameter | Description ----- | ----- `per_float_feature_quantization` | The quantization description for the specified feature or list of features.
Description format for a single feature:
```FeatureId[:border_count=BorderCount][:nan_mode=BorderType][:border_type=border_selection_method]```| Examples: - ``` per_float_feature_quantization='0:border_count=1024' ``` In this example, the feature indexed 0 has 1024 borders. - ```python per_float_feature_quantization=['0:border_count=1024', '1:border_count=1024'] ``` In this example, features indexed 0 and 1 have 1024 borders. - R Parameter | Description ----- | ----- `per_float_feature_quantization` | The quantization description for the specified feature or list of features.
Description format for a single feature:
```FeatureId[:border_count=BorderCount][:nan_mode=BorderType][:border_type=border_selection_method]```| Examples: - ```r per_float_feature_quantization = '0:border_count=1024') ``` In this example, the feature indexed 0 has 1024 borders. - ```r per_float_feature_quantization = c('0:border_count=1024', '1:border_count=1024' ``` In this example, features indexed 0 and 1 have 1024 borders. {% endlist %} ## Methods for hyperparameter search {#defining-optimal-parameter-values} The Python package provides Grid and Randomized search methods for searching optimal parameter values for training the model with the given dataset. {% cut "Parameters" %} Class | Method | Description ----- | ----- | ----- [CatBoost](python-reference_catboost.md) | [grid_search](python-reference_catboost_grid_search.md) | A simple grid search over specified parameter values for a model.| [CatBoost](python-reference_catboost.md) | [randomized_search](python-reference_catboost_randomized_search.md) | A simple randomized search on hyperparameters. | [CatBoostClassifier](python-reference_catboostclassifier.md) | [grid_search](python-reference_catboostclassifier_grid_search.md) | A simple grid search over specified parameter values for a model.| [CatBoostClassifier](python-reference_catboostclassifier.md) | [randomized_search](python-reference_catboostclassifier_randomized_search.md) | A simple randomized search on hyperparameters. [CatBoostRegressor](python-reference_catboostregressor.md) | [grid_search](python-reference_catboostregressor_grid_search.md) | A simple grid search over specified parameter values for a model. | [CatBoostRegressor](python-reference_catboostregressor.md) | [randomized_search](python-reference_catboostregressor_randomized_search.md) | A simple randomized search on hyperparameters. | {% endcut %} ## Methods for hyperparameter search by optuna Optuna is a famous hyperparameter optimization framework. Optuna enables efficient hyperparameter optimization by adopting state-of-the-art algorithms for sampling hyperparameters and pruning efficiently unpromising trials. Catboost supports to stop unpromising trial of hyperparameter by callbacking after iteration functionality. [Pull Request](https://github.com/catboost/catboost/pull/1697/files#diff-ccca44461ac6b094190f29fec157a227996e226ea483213680dd0a152cd412eaR9679) The following is an optuna example that demonstrates a pruner for CatBoost. [Example](https://github.com/optuna/optuna-examples/blob/main/catboost/catboost_pruning.py)