Repository navigation
docs: fix docstring parameter names that do not match signatures - #48575
Merged
Merged
Conversation
- utils/peft_utils.py check_peft_version documented 'version'; the parameter is min_version - integrations/hub_kernels.py load_and_register_attn_kernel documented 'attn_wrapper'; the parameter is attention_wrapper - pipelines/document_question_answering.py match_and_aggregate-style fn documented 'topk'; the parameter is top_k Docstring-only; found via an AST docstring-Args vs signature sweep.
Contributor
CI recapDashboard: View test results in Grafana |
vasqu
enabled auto-merge
September 7, 2026 13:22
|
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. |
sbucaille
pushed a commit
to sbucaille/transformers
that referenced
this pull request
Sep 16, 2026
…gingface#48575) - utils/peft_utils.py check_peft_version documented 'version'; the parameter is min_version - integrations/hub_kernels.py load_and_register_attn_kernel documented 'attn_wrapper'; the parameter is attention_wrapper - pipelines/document_question_answering.py match_and_aggregate-style fn documented 'topk'; the parameter is top_k Docstring-only; found via an AST docstring-Args vs signature sweep.
This was referenced Sep 17, 2026
pull Bot
pushed a commit
to sandeepyadav1478/transformers
that referenced
this pull request
Sep 18, 2026
…ace#48904) - MaxTimeCriteria: the docstring prose and Args entry said 'initial_time'; the parameter is 'initial_timestamp'. - RTDetrLoss / DFineLoss: the Args blocks documented seven constructor parameters that do not exist (they are attributes built internally from config, and the matcher type was also stale); replaced with a single config entry. Follows up on huggingface#48575/huggingface#48576 in the same docstring-vs-signature lane.
This file contains hidden or 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
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.
Docstring-only fixes, each verified against the signature directly above it (found via an AST docstring-Args vs signature sweep):
src/transformers/utils/peft_utils.pycheck_peft_version(min_version: str): docstring saidversion (str)src/transformers/integrations/hub_kernels.pyload_and_register_attn_kernel(..., attention_wrapper: Callable | None = None, …): docstring saidattn_wrappersrc/transformers/pipelines/document_question_answering.py(match_and_aggregate-style fn withtop_k=1): docstring saidtopk (int)Docstrings only — no code change.