[Doc] Improve docs #91
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
|
The documentation is not available anymore as the PR was closed or merged. |
lvwerra
reviewed
Jan 18, 2023
docs/source/trainer.mdx
Outdated
| @@ -0,0 +1,12 @@ | |||
| # Trainer | |||
|
|
|||
| At TRL we plan to release several RLHF algorithms, we started our journey with PPO (Proximal Policy Optimisation) with an implementation that largely follows the structure introduced in the paper "Fine-Tuning Language Models from Human Preferences" by D. Ziegler et al. [[paper](https://arxiv.org/pdf/1909.08593.pdf), [code](https://github.com/openai/lm-human-preferences)]. | |||
There was a problem hiding this comment.
Since adding new algorithms is not on the roadmap at the moment maybe let's just focus on PPO :)
We could also add a sentence or two about the classes. E.g. that they are inspired/influence by the transformers.Trainer and are adapted to RL.
There was a problem hiding this comment.
Thanks! Adapted the text in da456cf
Co-authored-by: Leandro von Werra <lvwerra@users.noreply.github.com>
…to improve-doc
lvwerra
approved these changes
Jan 18, 2023
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.
Add the following on the documentation
API
AutoModelForCausalLMWithValueHead&PreTrainedModelWrapper)PPOTrainer&PPOConfig)