Skip to content

Commit

Permalink
[docs][python][scikit-learn] added note for LGBMRanker (#4243)
Browse files Browse the repository at this point in the history
  • Loading branch information
StrikerRUS authored Apr 30, 2021
1 parent 91f72e2 commit 023dc53
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion python-package/lightgbm/sklearn.py
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,14 @@ def n_classes_(self):


class LGBMRanker(LGBMModel):
"""LightGBM ranker."""
"""LightGBM ranker.
.. warning::
scikit-learn doesn't support ranking applications yet,
therefore this class is not really compatible with the sklearn ecosystem.
Please use this class mainly for training and applying ranking models in common sklearnish way.
"""

def fit(self, X, y,
sample_weight=None, init_score=None, group=None,
Expand Down

0 comments on commit 023dc53

Please sign in to comment.