Improve docstrings and type hints in scheduling_amused.py #12623
+132
−19
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
delmalih
force-pushed
the
improve-docstring-scheduling-amused
branch
2 times, most recently
from
8c8c848 to
67f931b
Compare
- Add complete type hints for helper functions (gumbel_noise, mask_by_random_topk) - Enhance AmusedSchedulerOutput with proper Optional typing - Add comprehensive docstrings for AmusedScheduler class - Improve __init__, set_timesteps, step, and add_noise methods - Fix type hints to match documentation conventions - All changes follow project standards from issue huggingface#9567
delmalih
force-pushed
the
improve-docstring-scheduling-amused
branch
from
b21f59a to
38cf8fd
Compare
- Update type hints for `prev_sample` and `pred_original_sample` in `AmusedSchedulerOutput` to reflect their tensor types. - Improve docstring for `gumbel_noise` to specify the output tensor's dtype and device. - Refine `AmusedScheduler` class documentation, including detailed descriptions of the masking schedule and temperature parameters. - Adjust type hints in `set_timesteps` and `step` methods for better clarity and consistency.
stevhliu
approved these changes
Nov 12, 2025
Member
stevhliu
left a comment
stevhliu
left a comment
There was a problem hiding this comment.
Very nice, thanks for improving!
- Replace generic [Amused] reference with specific [`AmusedPipeline`] reference for consistency with project documentation conventions
delmalih
force-pushed
the
improve-docstring-scheduling-amused
branch
from
525fcfe to
c5cc592
Compare
|
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. |
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 documentation and type hints in
scheduling_amused.pyto follow the project conventions as described in #9567.Changes made:
Helper functions:
gumbel_noise()functionmask_by_random_topk()functionAmusedSchedulerOutput class:
pred_original_sampleattribute (torch.Tensor→Optional[torch.Tensor])AmusedScheduler class:
temperaturesandtimesteps)__init__()methodset_timesteps()method with proper return type annotationstep()method with detailed parameter descriptionsstep():timestepandstarting_mask_ratioadd_noise()methodAll docstrings follow the standard format with proper Args and Returns sections, using the backtick notation for types as per project conventions.
Context
This is part of a broader effort to improve documentation across all scheduler files in
src/diffusers/schedulers/. See issue #9567 for details.Related PRs:
Testing
make stylepassed (with automatic formatting applied)make qualitypassedBefore submitting
Who can review?
@yiyixuxu (Schedulers maintainer)