Skip to content

Commit

Permalink
[doc][dask] Add notes for partitioning. [skip ci] (#11146)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivialfis authored Jan 10, 2025
1 parent 51b3c46 commit b4a7cd1
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions python-package/xgboost/dask/__init__.py
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

0 comments on commit b4a7cd1

Please sign in to comment.