Skip to content

Fix README style #4619

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.

Sign up for GitHub

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

Jump to bottom
Merged
sergiopaniego merged 1 commit into from
Dec 4, 2025
Merged

Fix README style #4619

sergiopaniego merged 1 commit into from
Dec 4, 2025

Conversation

@sergiopaniego
Copy link
Member

@sergiopaniego sergiopaniego commented Dec 4, 2025

What does this PR do?

Fixes # (issue)

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?
  • Did you write any new necessary tests?

Who can review?

@albertvillanova @qgallouedec

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Dec 4, 2025

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.

albertvillanova
albertvillanova approved these changes Dec 4, 2025
View reviewed changes
Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@sergiopaniego sergiopaniego merged commit 495381d into main Dec 4, 2025
3 checks passed
@sergiopaniego sergiopaniego deleted the typo-readme branch December 4, 2025 10:32
qgallouedec pushed a commit to neha222222/trl that referenced this pull request Dec 5, 2025
@sergiopaniego @qgallouedec
Fix README style (huggingface#4619)
724f6ab
qgallouedec added a commit to neha222222/trl that referenced this pull request Dec 5, 2025
@qgallouedec
Squashed commit of the following:
76a3106 
commit cbd90d4
Author: Albert Villanova del Moral <[email protected]>
Date:   Thu Dec 4 20:05:43 2025 +0100

    Remove deprecated batched formatting in GOLDTrainer (huggingface#4622)

commit 903b57d
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 19:16:00 2025 +0100

    Update ministral notebooks with official bf16 ckpt (huggingface#4626)

commit 9266135
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 19:01:46 2025 +0100

    Fix link to OpenEnv blog in docs (huggingface#4625)

commit 495381d
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 11:32:34 2025 +0100

    Fix README style (huggingface#4619)

commit ddb65e8
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Dec 3 21:20:40 2025 +0100

    Add experimental imports to docs (huggingface#4616)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 5fab472
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Dec 3 17:38:16 2025 +0100

    Replace arXiv paper links with HF links (huggingface#4613)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit a3c1dfb
Author: Sergio Paniego Blanco <[email protected]>
Date:   Wed Dec 3 17:28:45 2025 +0100

    Add ministral 3 free notebooks (huggingface#4614)

commit 560fd3d
Author: Pramodith Ballapuram <[email protected]>
Date:   Wed Dec 3 10:12:20 2025 +0000

    [GRPOTrainer]: Add SAPO Loss (huggingface#4600)

commit 814d4af
Author: Quentin Gallouédec <[email protected]>
Date:   Tue Dec 2 15:52:51 2025 -0700

    Move MergeModelCallback to experimental (huggingface#4608)

    Co-authored-by: Albert Villanova del Moral <[email protected]>

commit 2a81076
Author: Sergio Paniego Blanco <[email protected]>
Date:   Tue Dec 2 15:07:11 2025 +0100

    Fixed OpenEnv example scripts (huggingface#4610)

commit de343cd
Author: Albert Villanova del Moral <[email protected]>
Date:   Tue Dec 2 07:32:22 2025 +0100

    Remove deprecations for 0.26 release (huggingface#4607)

commit 07b4a84
Author: Quentin Gallouédec <[email protected]>
Date:   Mon Dec 1 12:55:24 2025 -0700

    Silence experimental warnings when imported in the stable (huggingface#4606)

commit c55ef4b
Author: Quentin Gallouédec <[email protected]>
Date:   Mon Dec 1 12:40:42 2025 -0700

    Update How-to guides (huggingface#4604)

commit c686d7d
Author: Albert Villanova del Moral <[email protected]>
Date:   Mon Dec 1 20:34:31 2025 +0100

    Raise FutureWarning for classes moved to experimental (huggingface#4605)

commit c7d172b
Author: Behrooz Azarkhalili <[email protected]>
Date:   Mon Dec 1 01:47:22 2025 -0800

    docs: Expand speeding up training guide with acceleration methods (huggingface#4428)

    Co-authored-by: Sergio Paniego Blanco <[email protected]>

commit f1dfef0
Author: Behrooz Azarkhalili <[email protected]>
Date:   Mon Dec 1 01:39:08 2025 -0800

    docs: Expand training customization examples (huggingface#4427)

    Co-authored-by: Sergio Paniego Blanco <[email protected]>

commit eb76389
Author: LeonEricsson <[email protected]>
Date:   Sun Nov 30 16:45:21 2025 +0100

    [GRPO] Sequence-level TIS & MIS (huggingface#4530)

commit 0726977
Author: xuanduy04 <[email protected]>
Date:   Fri Nov 28 23:56:22 2025 +0700

    docs: Add Beyond the 80/20 Rule (2506.01939) to Paper Index (huggingface#4580)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 9731d08
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 17:43:38 2025 +0100

    Revert "Hotfix CI with dev dependencies: xfail test_prepare_inputs_for_generation" (huggingface#4587)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 84a0bbc
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 16:13:56 2025 +0100

    Fix 'generation_config' AttributeError (huggingface#4596)

commit f67c3f2
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 15:46:02 2025 +0100

    Remove module-level imports of extra deps in experimental.judges (huggingface#4598)

commit cb5fdf9
Author: Albert Villanova del Moral <[email protected]>
Date:   Thu Nov 27 11:08:26 2025 +0100

    Add missing require_bitsandbytes marker to CI tests (huggingface#4586)

commit 4a3b584
Author: juejuezi <[email protected]>
Date:   Thu Nov 27 00:11:56 2025 +0800

    fix: use shift_labels for metrics when using CP or SP (huggingface#4579)

    Co-authored-by: Kashif Rasul <[email protected]>

commit d2e4315
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Nov 26 15:40:15 2025 +0100

    Revert hotfix Fall back to config.text_config._name_or_path (huggingface#4581)

commit 357e331
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:55:46 2025 -0700

    Move tests for GSPOTokenTrainer to experimental (huggingface#4572)

commit a59f2cf
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:50:44 2025 -0700

    Move `WinRateCallback` to experimental (huggingface#4558)

    Co-authored-by: Behrooz Azarkhalili <[email protected]>
    Co-authored-by: Kashif Rasul <[email protected]>

commit cf431db
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:11:04 2025 -0700

    Fix PPO example (huggingface#4556)

commit cac9f1d
Author: Pramodith Ballapuram <[email protected]>
Date:   Tue Nov 25 21:27:58 2025 +0000

    Fix Replay Buffer docs. (huggingface#4574)
qgallouedec added a commit to neha222222/trl that referenced this pull request Dec 5, 2025
@qgallouedec
Squashed commit of the following:
0d48b86 
commit f278d03
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Dec 5 19:34:42 2025 +0100

    Remove no longer applicable warning once BCO was moved to experimental (huggingface#4628)

commit e7071bf
Author: Quentin Gallouédec <[email protected]>
Date:   Fri Dec 5 10:07:16 2025 -0700

    Add logos as assets (huggingface#4627)

    Co-authored-by: Sergio Paniego Blanco <[email protected]>

commit 794d87f
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Dec 5 08:45:20 2025 +0100

    Add missing experimental autodoc classes to docs (huggingface#4618)

commit bc7888d
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Dec 5 07:48:33 2025 +0100

    Raise FutureWarning for trainer moved to experimental (huggingface#4620)

commit fce5dfd
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Dec 5 07:34:04 2025 +0100

    Raise warnings at 2nd stack level (huggingface#4621)

commit c5da8ec
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Dec 5 07:33:04 2025 +0100

    Silence experimental warning during docs build (huggingface#4623)

commit 2af35fb
Author: Quentin Gallouédec <[email protected]>
Date:   Thu Dec 4 21:23:41 2025 -0700

    Clean up model preparation  (huggingface#4577)

commit cbd90d4
Author: Albert Villanova del Moral <[email protected]>
Date:   Thu Dec 4 20:05:43 2025 +0100

    Remove deprecated batched formatting in GOLDTrainer (huggingface#4622)

commit 903b57d
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 19:16:00 2025 +0100

    Update ministral notebooks with official bf16 ckpt (huggingface#4626)

commit 9266135
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 19:01:46 2025 +0100

    Fix link to OpenEnv blog in docs (huggingface#4625)

commit 495381d
Author: Sergio Paniego Blanco <[email protected]>
Date:   Thu Dec 4 11:32:34 2025 +0100

    Fix README style (huggingface#4619)

commit ddb65e8
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Dec 3 21:20:40 2025 +0100

    Add experimental imports to docs (huggingface#4616)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 5fab472
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Dec 3 17:38:16 2025 +0100

    Replace arXiv paper links with HF links (huggingface#4613)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit a3c1dfb
Author: Sergio Paniego Blanco <[email protected]>
Date:   Wed Dec 3 17:28:45 2025 +0100

    Add ministral 3 free notebooks (huggingface#4614)

commit 560fd3d
Author: Pramodith Ballapuram <[email protected]>
Date:   Wed Dec 3 10:12:20 2025 +0000

    [GRPOTrainer]: Add SAPO Loss (huggingface#4600)

commit 814d4af
Author: Quentin Gallouédec <[email protected]>
Date:   Tue Dec 2 15:52:51 2025 -0700

    Move MergeModelCallback to experimental (huggingface#4608)

    Co-authored-by: Albert Villanova del Moral <[email protected]>

commit 2a81076
Author: Sergio Paniego Blanco <[email protected]>
Date:   Tue Dec 2 15:07:11 2025 +0100

    Fixed OpenEnv example scripts (huggingface#4610)

commit de343cd
Author: Albert Villanova del Moral <[email protected]>
Date:   Tue Dec 2 07:32:22 2025 +0100

    Remove deprecations for 0.26 release (huggingface#4607)

commit 07b4a84
Author: Quentin Gallouédec <[email protected]>
Date:   Mon Dec 1 12:55:24 2025 -0700

    Silence experimental warnings when imported in the stable (huggingface#4606)

commit c55ef4b
Author: Quentin Gallouédec <[email protected]>
Date:   Mon Dec 1 12:40:42 2025 -0700

    Update How-to guides (huggingface#4604)

commit c686d7d
Author: Albert Villanova del Moral <[email protected]>
Date:   Mon Dec 1 20:34:31 2025 +0100

    Raise FutureWarning for classes moved to experimental (huggingface#4605)

commit c7d172b
Author: Behrooz Azarkhalili <[email protected]>
Date:   Mon Dec 1 01:47:22 2025 -0800

    docs: Expand speeding up training guide with acceleration methods (huggingface#4428)

    Co-authored-by: Sergio Paniego Blanco <[email protected]>

commit f1dfef0
Author: Behrooz Azarkhalili <[email protected]>
Date:   Mon Dec 1 01:39:08 2025 -0800

    docs: Expand training customization examples (huggingface#4427)

    Co-authored-by: Sergio Paniego Blanco <[email protected]>

commit eb76389
Author: LeonEricsson <[email protected]>
Date:   Sun Nov 30 16:45:21 2025 +0100

    [GRPO] Sequence-level TIS & MIS (huggingface#4530)

commit 0726977
Author: xuanduy04 <[email protected]>
Date:   Fri Nov 28 23:56:22 2025 +0700

    docs: Add Beyond the 80/20 Rule (2506.01939) to Paper Index (huggingface#4580)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 9731d08
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 17:43:38 2025 +0100

    Revert "Hotfix CI with dev dependencies: xfail test_prepare_inputs_for_generation" (huggingface#4587)

    Co-authored-by: Quentin Gallouédec <[email protected]>

commit 84a0bbc
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 16:13:56 2025 +0100

    Fix 'generation_config' AttributeError (huggingface#4596)

commit f67c3f2
Author: Albert Villanova del Moral <[email protected]>
Date:   Fri Nov 28 15:46:02 2025 +0100

    Remove module-level imports of extra deps in experimental.judges (huggingface#4598)

commit cb5fdf9
Author: Albert Villanova del Moral <[email protected]>
Date:   Thu Nov 27 11:08:26 2025 +0100

    Add missing require_bitsandbytes marker to CI tests (huggingface#4586)

commit 4a3b584
Author: juejuezi <[email protected]>
Date:   Thu Nov 27 00:11:56 2025 +0800

    fix: use shift_labels for metrics when using CP or SP (huggingface#4579)

    Co-authored-by: Kashif Rasul <[email protected]>

commit d2e4315
Author: Albert Villanova del Moral <[email protected]>
Date:   Wed Nov 26 15:40:15 2025 +0100

    Revert hotfix Fall back to config.text_config._name_or_path (huggingface#4581)

commit 357e331
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:55:46 2025 -0700

    Move tests for GSPOTokenTrainer to experimental (huggingface#4572)

commit a59f2cf
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:50:44 2025 -0700

    Move `WinRateCallback` to experimental (huggingface#4558)

    Co-authored-by: Behrooz Azarkhalili <[email protected]>
    Co-authored-by: Kashif Rasul <[email protected]>

commit cf431db
Author: Quentin Gallouédec <[email protected]>
Date:   Wed Nov 26 04:11:04 2025 -0700

    Fix PPO example (huggingface#4556)

commit cac9f1d
Author: Pramodith Ballapuram <[email protected]>
Date:   Tue Nov 25 21:27:58 2025 +0000

    Fix Replay Buffer docs. (huggingface#4574)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@albertvillanova albertvillanova albertvillanova approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@sergiopaniego @HuggingFaceDocBuilderDev @albertvillanova