Skip to content

Commit

Permalink
[doc] FIx learning to rank (dmlc#10412)
Browse files Browse the repository at this point in the history
  • Loading branch information
nocluebutalotofit authored Jun 14, 2024
1 parent cf0c1d0 commit 01ff2b2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/tutorials/learning_to_rank.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The simplest way to train a ranking model is by using the scikit-learn estimator
.. code-block:: python
ranker = xgb.XGBRanker(tree_method="hist", lambdarank_num_pair_per_sample=8, objective="rank:ndcg", lambdarank_pair_method="topk")
ranker.fit(X, y, qid=qid[sorted_idx])
ranker.fit(X, y, qid=qid)
Please note that, as of writing, there's no learning-to-rank interface in scikit-learn. As a result, the :py:class:`xgboost.XGBRanker` class does not fully conform the scikit-learn estimator guideline and can not be directly used with some of its utility functions. For instances, the ``auc_score`` and ``ndcg_score`` in scikit-learn don't consider query group information nor the pairwise loss. Most of the metrics are implemented as part of XGBoost, but to use scikit-learn utilities like :py:func:`sklearn.model_selection.cross_validation`, we need to make some adjustments in order to pass the ``qid`` as an additional parameter for :py:meth:`xgboost.XGBRanker.score`. Given a data frame ``X`` (either pandas or cuDF), add the column ``qid`` as follows:

Expand Down

0 comments on commit 01ff2b2

Please sign in to comment.