Updated README.md with CLI examples and additional usage instructions #2199
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
Added Command Line Interface (CLI) examples for SFT, DPO, and Chat features. Improved the "How to Use" section by providing code examples for SFTTrainer and RewardTrainer. Included installation instructions for both Python Package and source-based installation. Refined highlights to better showcase efficiency and scalability features. Updated the repository clone instructions for working with examples. Added new links to CLI documentation and contribution guide for better navigation.
qgallouedec
reviewed
Oct 8, 2024
qgallouedec
reviewed
Oct 8, 2024
qgallouedec
reviewed
Oct 8, 2024
README.md
Outdated
|
|
||
| ```bash | ||
| pip install trl | ||
| ``` | ||
|
|
There was a problem hiding this comment.
You need to revert this change
|
Can you also update the badges with the following: <p align="center">
<a href="https://github.com/huggingface/trl/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/huggingface/trl.svg?color=blue"></a>
<a href="https://huggingface.co/docs/trl/index"><img alt="Documentation" src="https://img.shields.io/website?url=https%3A%2F%2Fhuggingface.co%2Fdocs%2Ftrl%2Findex&down_color=red&down_message=offline&up_color=blue&up_message=online"></a>
<a href="https://github.com/huggingface/trl/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/huggingface/trl.svg"></a>
</p>It will remove these: 
|
|
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. |
edbeeching
approved these changes
Oct 11, 2024
kashif
reviewed
Oct 11, 2024
lewtun
approved these changes
Oct 11, 2024
There was a problem hiding this comment.
Thanks for improving the README @Singhal1808 ! Overall it looks good with some nits from my side and the changes that need reverting from @qgallouedec
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
Co-authored-by: lewtun <lewis.c.tunstall@gmail.com>
qgallouedec
reviewed
Oct 11, 2024
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.
Added Command Line Interface (CLI) examples for SFT, DPO, and Chat features. Improved the "How to Use" section by providing code examples for SFTTrainer and RewardTrainer. Included installation instructions for both Python Package and source-based installation. Refined highlights to better showcase efficiency and scalability features. Updated the repository clone instructions for working with examples. Added new links to CLI documentation and contribution guide for better navigation.
What does this PR do?
Fixes # (issue)
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.