.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "python/examples/predict_leaf_indices.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_python_examples_predict_leaf_indices.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_python_examples_predict_leaf_indices.py:


Demo for obtaining leaf index
=============================

.. GENERATED FROM PYTHON SOURCE LINES 5-32

.. code-block:: Python

    import os

    import xgboost as xgb

    # load data in do training
    CURRENT_DIR = os.path.dirname(__file__)
    dtrain = xgb.DMatrix(
        os.path.join(CURRENT_DIR, "../data/agaricus.txt.train?format=libsvm")
    )
    dtest = xgb.DMatrix(
        os.path.join(CURRENT_DIR, "../data/agaricus.txt.test?format=libsvm")
    )
    param = {"max_depth": 2, "eta": 1, "objective": "binary:logistic"}
    watchlist = [(dtest, "eval"), (dtrain, "train")]
    num_round = 3
    bst = xgb.train(param, dtrain, num_round, watchlist)

    print("start testing predict the leaf indices")
    # predict using first 2 tree
    leafindex = bst.predict(
        dtest, iteration_range=(0, 2), pred_leaf=True, strict_shape=True
    )
    print(leafindex.shape)
    print(leafindex)
    # predict all trees
    leafindex = bst.predict(dtest, pred_leaf=True)
    print(leafindex.shape)


.. _sphx_glr_download_python_examples_predict_leaf_indices.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

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

      :download:`Download Jupyter notebook: predict_leaf_indices.ipynb <predict_leaf_indices.ipynb>`

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

      :download:`Download Python source code: predict_leaf_indices.py <predict_leaf_indices.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: predict_leaf_indices.zip <predict_leaf_indices.zip>`


.. only:: html

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

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