Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📜 Update README and doc index #2986

Merged
merged 3 commits into from
Feb 28, 2025
Merged

📜 Update README and doc index #2986

merged 3 commits into from
Feb 28, 2025

Conversation

qgallouedec
Copy link
Member

@qgallouedec qgallouedec commented Feb 28, 2025

What does this PR do?

  • Add Open-R1 blog post in the index page of the doc
  • Reorganise README/Doc to highlight our top trainers (SFT, GRPO, DPO, Reward)
  • Drop some old content

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines.
  • Did you write any new necessary tests?

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.

@HuggingFaceDocBuilderDev

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.

@qgallouedec qgallouedec requested a review from lewtun February 28, 2025 10:54
@qgallouedec qgallouedec changed the title Update README and doc index 📜 Update README and doc index Feb 28, 2025
@qgallouedec qgallouedec merged commit 3d94e4e into main Feb 28, 2025
13 of 14 checks passed
@qgallouedec qgallouedec deleted the update-index-and-readme branch February 28, 2025 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants