Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc][dask] Add notes for partitioning. [skip ci] #11146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[doc][dask] Add notes for partitioning. [skip ci] #11146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions python-package/xgboost/dask/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,8 +274,13 @@ class DaskDMatrix:

.. note::

DaskDMatrix does not repartition or move data between workers. It's
the caller's responsibility to balance the data.
`DaskDMatrix` does not repartition or move data between workers. It's the
caller's responsibility to balance the data.

.. note::

For aligning partitions with ranking query groups, use the
:py:class:`DaskXGBRanker` and its ``allow_group_split`` option.

.. versionadded:: 1.0.0

Expand Down Expand Up @@ -587,7 +592,10 @@ def first_valid(results: Iterable[Optional[_MapRetT]]) -> Optional[_MapRetT]:


class DaskQuantileDMatrix(DaskDMatrix):
"""A dask version of :py:class:`QuantileDMatrix`."""
"""A dask version of :py:class:`QuantileDMatrix`. See :py:class:`DaskDMatrix` for
parameter documents.

"""

@_deprecate_positional_args
def __init__(
Expand Down