[modular] detect stale auto docstrings in CI + regenerate current ones#14241
Open
yiyixuxu wants to merge 3 commits into
Open
[modular] detect stale auto docstrings in CI + regenerate current ones#14241yiyixuxu wants to merge 3 commits into
yiyixuxu wants to merge 3 commits into
Conversation
Mechanical output of `python utils/modular_auto_docstring.py src/diffusers/modular_pipelines --fix_and_overwrite` on current main. These docstrings drifted because the CI check only verifies a docstring exists, not that its content matches the current block declarations. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…trings Check mode now regenerates each # auto_docstring docstring the same way --fix_and_overwrite does (generate -> insert -> ruff/doc-builder format, on a temp copy) and compares with the checked-in file, reporting the stale classes. Works like check_copies: forgetting to run the fixer now fails CI on the PR that caused the drift, including when the causing change is in another file (leaf block declarations, templates, specs). The check now imports diffusers to evaluate doc properties, so the check_auto_docs CI job moves to the torch container with the test job's dependency install. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
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. |
sayakpaul
approved these changes
Jul 20, 2026
sayakpaul
left a comment
sayakpaul
left a comment
Member
There was a problem hiding this comment.
Thanks! I think it might also make sense to add a thin test suite for the auto docstring utility in modular since it's an important user-facing feature.
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
3 participants
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.
The
# auto_docstringcheck only verified that a docstring exists, regardless of whether its contents are up to date https://github.com/huggingface/diffusers/blob/main/utils/modular_auto_docstring.py#L254so whenever a user updates something on the block that would cause the docstring to change (e.g., the block
descriptionfield,InputParam) and forgets to run theutils/modular_auto_docstring.py --fix_and_overwrite` again, the docstring would go stale, and our CI will not catch itthis PR:
(1) regenerates the currently stale docstrings.
(2) makes check mode work like
check_copies: regenerate each docstring in memory through the exact same workflow as --fix_and_overwrite (generate → insert → ruff/doc-builder format on a temp copy) and fail with the list of stale classes if the result differs from the file.For contributors: if CI fails, run python utils/modular_auto_docstring.py --fix_and_overwrite from the repo root and push — same as make fix-copies.