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

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_python_dask-examples_sklearn_cpu_training.py>`
        to download the full example code.

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

.. _sphx_glr_python_dask-examples_sklearn_cpu_training.py:


Use scikit-learn regressor interface with CPU histogram tree method
===================================================================

.. GENERATED FROM PYTHON SOURCE LINES 5-42

.. code-block:: Python


    from dask import array as da
    from dask.distributed import Client, LocalCluster

    from xgboost import dask as dxgb


    def main(client: Client) -> dxgb.Booster:
        # generate some random data for demonstration
        n = 100
        m = 10000
        partition_size = 100
        X = da.random.random((m, n), partition_size)
        y = da.random.random(m, partition_size)

        regressor = dxgb.DaskXGBRegressor(verbosity=1, n_estimators=2)
        regressor.set_params(tree_method="hist")
        # assigning client here is optional
        regressor.client = client

        regressor.fit(X, y, eval_set=[(X, y)])
        prediction = regressor.predict(X)

        bst = regressor.get_booster()
        history = regressor.evals_result()

        print("Evaluation history:", history)
        # returned prediction is always a dask array.
        assert isinstance(prediction, da.Array)
        return bst  # returning the trained model


    if __name__ == "__main__":
        # or use other clusters for scaling
        with LocalCluster(n_workers=4, threads_per_worker=1) as cluster:
            with Client(cluster) as client:
                main(client)


.. _sphx_glr_download_python_dask-examples_sklearn_cpu_training.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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