Skip to content

Conversation

@albertvillanova
Copy link
Member

Align docstring parameters with function definitions.

This pull request fixes inconsistencies between function signatures and their corresponding docstrings. Specifically:

  • Remove parameters documented in docstrings but missing in the function definition.
  • Add missing parameters to docstrings where they were present in the function definition.
  • Ensure parameter descriptions remain consistent and accurate.

@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.

Copy link
Member

@qgallouedec qgallouedec left a comment

Choose a reason for hiding this comment

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

lgtm!

@albertvillanova
Copy link
Member Author

albertvillanova commented Sep 7, 2025

I think the failing tests are unrelated to this PR: https://github.com/huggingface/trl/actions/runs/17498230112/job/49704509416?pr=4017

AttributeError: 'Accelerator' object has no attribute 'parallelism_config'

Associated PR:

So, I'm merging this PR.

@albertvillanova albertvillanova merged commit c9484b1 into huggingface:main Sep 7, 2025
9 of 10 checks passed
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