Add missing trainer docstrings #4030
Merged
Conversation
This file contains hidden or 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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
kashif
approved these changes
Sep 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add missing docstrings in trainers:
GKDTrainer: https://huggingface.co/docs/trl/v0.22.2/en/gkd_trainer#trl.GKDTrainerPPOTrainer: https://huggingface.co/docs/trl/v0.22.2/en/ppo_trainer#trl.PPOTrainerRewardTrainer: https://huggingface.co/docs/trl/v0.22.2/en/reward_trainer#trl.RewardTrainerThis pull request adds and improves documentation for three core trainer classes in the TRL library:
GKDTrainer,PPOTrainer, andRewardTrainer. The main changes involve introducing detailed docstrings that clarify the purpose, usage, and arguments to instantiate each trainer, making the codebase easier to understand and maintain.These updates will help new contributors and users understand the trainers' roles and how to configure them properly.