XGBRanker documentation: few clarifications #8356
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I would like to propose these updates to the documentation of XGBRanker to clarify few aspects: - `predict` method can work on multiple groups. I found several online resources that suggests to split the input data by group and call `predict` on each group individually. believe this is a misconception derived by the `group`/`qid` parameter requirement in the `fit` method. - `qid` parameter in `fit` method needs an example on how it can be used. I couldn't find an online example that makes use of it. I do not believe my text is particularly good, but if you could just consider the intent and maybe find a better way of writing it, than it would be great as well. Thanks.
trivialfis
approved these changes
Oct 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would like to propose these updates to the documentation of XGBRanker to clarify few aspects:
predictmethod can work on multiple groups. I found several online resources that suggests to split the input data by group and callpredicton each group individually. I believe this is a misconception derived by thegroup/qidparameter requirement in thefitmethod.qidparameter infitmethod needs an example on how it can be used. I couldn't find an online example that makes use of it.I do not believe my text is particularly good, but if you could just consider the intent and maybe find a better way of writing it, than it would be great as well.
Thanks.