Back to Catboost

CatBoostRegressor

catboost/docs/en/concepts/python-reference_catboostregressor.md

1.2.1013.6 KB
Original Source

CatBoostRegressor

python
class CatBoostRegressor(iterations=None,
                        learning_rate=None,
                        depth=None,
                        l2_leaf_reg=None,
                        model_size_reg=None,
                        rsm=None,
                        loss_function='RMSE',
                        border_count=None,
                        feature_border_type=None,
                        per_float_feature_quantization=None,
                        input_borders=None,
                        output_borders=None,
                        fold_permutation_block=None,
                        od_pval=None,
                        od_wait=None,
                        od_type=None,
                        nan_mode=None,
                        counter_calc_method=None,
                        leaf_estimation_iterations=None,
                        leaf_estimation_method=None,
                        thread_count=None,
                        random_seed=None,
                        use_best_model=None,
                        best_model_min_trees=None,
                        verbose=None,
                        silent=None,
                        logging_level=None,
                        metric_period=None,
                        ctr_leaf_count_limit=None,
                        store_all_simple_ctr=None,
                        max_ctr_complexity=None,
                        has_time=None,
                        allow_const_label=None,
                        one_hot_max_size=None,
                        random_strength=None,
                        name=None,
                        ignored_features=None,
                        train_dir=None,
                        custom_metric=None,
                        eval_metric=None,
                        bagging_temperature=None,
                        save_snapshot=None,
                        snapshot_file=None,
                        snapshot_interval=None,
                        fold_len_multiplier=None,
                        used_ram_limit=None,
                        gpu_ram_part=None,
                        pinned_memory_size=None,
                        allow_writing_files=None,
                        final_ctr_computation_mode=None,
                        approx_on_full_history=None,
                        boosting_type=None,
                        simple_ctr=None,
                        combinations_ctr=None,
                        per_feature_ctr=None,
                        ctr_target_border_count=None,
                        task_type=None,
                        device_config=None,
                        devices=None,
                        bootstrap_type=None,
                        subsample=None,
                        sampling_unit=None,
                        dev_score_calc_obj_block_size=None,
                        max_depth=None,
                        n_estimators=None,
                        num_boost_round=None,
                        num_trees=None,
                        colsample_bylevel=None,
                        random_state=None,
                        reg_lambda=None,
                        objective=None,
                        eta=None,
                        max_bin=None,
                        gpu_cat_features_storage=None,
                        data_partition=None,
                        metadata=None,
                        early_stopping_rounds=None,
                        cat_features=None,
                        grow_policy=None,
                        min_data_in_leaf=None,
                        min_child_samples=None,
                        max_leaves=None,
                        num_leaves=None,
                        score_function=None,
                        leaf_estimation_backtracking=None,
                        ctr_history_unit=None,
                        monotone_constraints=None,
                        feature_weights=None,
                        penalties_coefficient=None,
                        first_feature_use_penalties=None,
                        model_shrink_rate=None,
                        model_shrink_mode=None,
                        langevin=None,
                        diffusion_temperature=None,
                        posterior_sampling=None,
                        boost_from_average=None,
                        fixed_binary_splits=None)

{{ dl--purpose }} {#purpose}

Implementation of the scikit-learn estimator API for CatBoost regression.

Supports model training, inference and auxiliary calculations like feature importance.

{{ dl--parameters }} {#parameters}

{% include python__parameters__metadata %}

{% include python__parameters__cat_features %}

{% include sections-with-methods-desc-see-training-params %}

{% include precedence-python--regressor--precedence-note %}

{{ dl--attributes }} {#attributes}

tree_count_

{% include tree_count_-tree_count__desc %}

feature_importances_

{% include feature_importances_-feature_importances__desc %}

random_seed_

{% include random_seed_-random_seed__desc %}

learning_rate_

{% include learning_rate_-learning_rate__desc %}

feature_names_

{% include feature_names_-feature_names__desc %}

evals_result_

{% include sections-with-methods-desc-python__get-evals-result__desc %}

best_score_

{% include sections-with-methods-desc-python__method__get_best_score__desc %}

best_iteration_

{% include sections-with-methods-desc-python__method__get_best_iteration__desc %}

{{ dl--methods }} {#methods}

fit

{% include sections-with-methods-desc-fit--purpose-desc %}

predict

{% include sections-with-methods-desc-predict--purpose %}

calc_leaf_indexes

{% include python-reference_catboost_calc_leaf_indexes-calc_leaf_indexes__desc %}

calc_feature_statistics

{% include get_feature_statistics-get_feature_statistics__desc__div %}

copy

{% include sections-with-methods-desc-copy--purpose %}

compare

{% include model-compare-compare__purpose %}

eval_metrics

{% include sections-with-methods-desc-python__eval-metrics__purpose %}

get_all_params

{% include get_all_params-python__get_all_params__desc__p %}

get_best_iteration

{% include sections-with-methods-desc-python__method__get_best_iteration__desc %}

get_best_score

{% include sections-with-methods-desc-python__method__get_best_score__desc %}

get_borders

{% include get_borders-get_borders__desc__div %}

get_evals_result

{% include sections-with-methods-desc-python__get-evals-result__desc %}

{{ function-name__get-feature-importance }}

{% include sections-with-methods-desc-feature_importances--purpose %}

get_metadata

Return a proxy object with metadata from the model's internal key-value string storage.

get_object_importance

{% include sections-with-methods-desc-python__get_object_importance__desc %}

get_param

{% include sections-with-methods-desc-get_param--purpose %}

get_params

{% include sections-with-methods-desc-get_params--purpose %}

get_scale_and_bias

{% include get_scale_and_bias-get_scale_and_bias__desc %}

get_test_eval

{% include sections-with-methods-desc-get_test_val--desc %}

{% include grid_search-python__grid_search--desc %}

is_fitted

{% include sections-with-methods-desc-is_fitted--purpose %}

load_model

{% include sections-with-methods-desc-load_model--purpose %}

plot_predictions

{% include plot_predictions-plot_predictions__desc__short %}

plot_tree

{% include plot_tree-python__plot-tree_desc__div %}

{% include randomized_search-python__randomized_search--desc %}

save_borders

{% include save_borders-save_model__div_desc %}

save_model

{% include sections-with-methods-desc-save_model--purpose %}

score

{% include catboost-regressor-score-scor__purpose %}

select_features

Select the best features from the dataset using the Recursive Feature Elimination algorithm.

set_feature_names

{% include non_pool__set_feature_names-non_pool__set_feature_names__div %}

set_params

{% include sections-with-methods-desc-set_params--purpose %}

set_scale_and_bias

{% include set_scale_and_bias-set_scale_and_bias__desc %}

shrink

{% include sections-with-methods-desc-shrink__purpose %}

staged_predict

{% include sections-with-methods-desc-staged_predict--purpose %}