Improve docstrings and type hints in scheduling_ddim.py #12622
+76
−39
Conversation
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
This was referenced Nov 10, 2025
delmalih
force-pushed
the
improve-docstring-scheduling-ddim
branch
from
aff1364 to
8ff3b89
Compare
Contributor
Author
|
Thanks for the review and the helpful suggestions. |
|
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. |
Member
|
Can you run |
- Add complete type hints for all function parameters - Enhance docstrings to follow project conventions - Add missing parameter descriptions Fixes huggingface#9567
- Update parameter types and descriptions for clarity - Improve explanations in method docstrings to align with project standards - Add optional annotations for parameters where applicable
- Update parameter types to use Literal for specific string options - Enhance docstring descriptions for clarity and consistency - Ensure all parameters have appropriate type annotations and defaults
- Replace "prevent singularities" with "avoid numerical instability" for better clarity - Add backticks around `alpha_bar` variable name for consistent formatting - Convert Imagen Video paper URLs to Hugging Face papers references
delmalih
force-pushed
the
improve-docstring-scheduling-ddim
branch
from
01194cf to
e1c7acf
Compare
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.
What does this PR do?
This PR improves the docstrings and type hints in
src/diffusers/schedulers/scheduling_ddim.pyto follow the project conventions as described in #9567.Changes made:
First commit: Initial improvements
Second commit: Further enhancements
Summary of improvements:
Context
This is part of a broader effort to improve documentation across all scheduler files in
src/diffusers/schedulers/. See issue #9567 for details.Testing
make stylemake qualityBefore submitting
Who can review?
cc @yiyixuxu @stevhliu @a-r-r-o-w for review