:orphan:

XGBoost Python Feature Walkthrough
==================================


This is a collection of examples for using the XGBoost Python package.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for using xgboost with sklearn">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_sklearn_parallel_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_sklearn_parallel.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using xgboost with sklearn</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for obtaining leaf index">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_predict_leaf_indices_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_predict_leaf_indices.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for obtaining leaf index</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script demonstrate how to access the eval metrics">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_evals_result_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_evals_result.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">This script demonstrate how to access the eval metrics</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for gamma regression">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_gamma_regression_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_gamma_regression.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for gamma regression</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for boosting from prediction">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_boost_from_prediction_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_boost_from_prediction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for boosting from prediction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for accessing the xgboost eval metrics by using sklearn interface">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_sklearn_evals_result_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_sklearn_evals_result.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for accessing the xgboost eval metrics by using sklearn interface</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    .. versionadded:: 1.3.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_feature_weights_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_feature_weights.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using feature weight to change column sampling</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for GLM">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_generalized_linear_model_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_generalized_linear_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for GLM</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for prediction using number of trees">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_predict_first_ntree_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_predict_first_ntree.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for prediction using number of trees</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is a simple example of using the native XGBoost interface, there are other interfaces in the Python package like scikit-learn interface and Dask interface.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_basic_walkthrough_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_basic_walkthrough.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Getting started with XGBoost</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For an introduction to XGBoost&#x27;s scikit-learn estimator interface, see /python/sklearn_estimator.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_sklearn_examples_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_sklearn_examples.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Collection of examples for using sklearn interface</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Experimental support for categorical data.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_categorical_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_categorical.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Getting started with categorical data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for using cross validation">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_cross_validation_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_cross_validation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using cross validation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Modifying existing trees is not a well established use for XGBoost, so feel free to experiment.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_update_process_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_update_process.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using process_type with prune and refresh</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for prediction using individual trees and model slices">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_individual_trees_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_individual_trees.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for prediction using individual trees and model slices</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="@author: Weichen Xu">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_spark_estimator_examples_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_spark_estimator_examples.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Collection of examples for using xgboost.spark estimator interface</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    .. versionadded:: 1.2.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_quantile_data_iterator_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_quantile_data_iterator.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using data iterator with Quantile DMatrix</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A simple demo for categorical data support using dataset from Kaggle categorical data tutorial.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_cat_in_the_dat_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_cat_in_the_dat.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Train XGBoost with cat_in_the_dat dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The demo is adopted from scikit-learn:">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_multioutput_regression_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_multioutput_regression.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">A demo for multi-output regression</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    .. versionadded:: 2.0.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_quantile_regression_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_quantile_regression.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quantile Regression</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for training continuation">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_continuation_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_continuation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for training continuation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The script showcases how to keep the categorical data encoding consistent across training and inference. There are many ways to attain the same goal, this script can be used as a starting point.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_cat_pipeline_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_cat_pipeline.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Feature engineering pipeline for categorical data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    .. versionadded:: 1.3.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_callbacks_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_callbacks.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for using and defining callback functions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is similar to the one in quantile_data_iterator.py, but for external memory instead of Quantile DMatrix.  The feature is not ready for production use yet.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_external_memory_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_external_memory.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Experimental support for external memory</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This demo is only applicable after (excluding) XGBoost 1.0.0, as before this version XGBoost returns transformed prediction for multi-class objective function.  More details in comments.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_custom_softmax_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_custom_softmax.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for creating customized multi-class objective function</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="  .. versionadded:: 2.0.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_learning_to_rank_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_learning_to_rank.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Getting started with learning to rank</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Demo for defining customized metric and objective.  Notice that for simplicity reason weight is not used in following example. In this script, we implement the Squared Log Error (SLE) objective and RMSLE metric as customized functions, then compare it with native implementation in XGBoost.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_custom_rmsle_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_custom_rmsle.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demo for defining a custom regression objective and metric</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    .. versionadded:: 3.0.0">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_distributed_extmem_basic_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_distributed_extmem_basic.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Experimental support for distributed training with external memory</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="See /tutorials/saving_model for details about the model serialization.">

.. only:: html

  .. image:: /python/examples/images/thumb/sphx_glr_model_parser_thumb.png
    :alt:

  :ref:`sphx_glr_python_examples_model_parser.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Demonstration for parsing JSON/UBJSON tree model files</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /python/examples/sklearn_parallel
   /python/examples/predict_leaf_indices
   /python/examples/evals_result
   /python/examples/gamma_regression
   /python/examples/boost_from_prediction
   /python/examples/sklearn_evals_result
   /python/examples/feature_weights
   /python/examples/generalized_linear_model
   /python/examples/predict_first_ntree
   /python/examples/basic_walkthrough
   /python/examples/sklearn_examples
   /python/examples/categorical
   /python/examples/cross_validation
   /python/examples/update_process
   /python/examples/individual_trees
   /python/examples/spark_estimator_examples
   /python/examples/quantile_data_iterator
   /python/examples/cat_in_the_dat
   /python/examples/multioutput_regression
   /python/examples/quantile_regression
   /python/examples/continuation
   /python/examples/cat_pipeline
   /python/examples/callbacks
   /python/examples/external_memory
   /python/examples/custom_softmax
   /python/examples/learning_to_rank
   /python/examples/custom_rmsle
   /python/examples/distributed_extmem_basic
   /python/examples/model_parser


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: examples_python.zip </python/examples/examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip </python/examples/examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_