docs: improve docstring scheduling folder - last batch - #14330
Conversation
stevhliu
left a comment
There was a problem hiding this comment.
Huge thanks for nearly single-handedly improving all these docstrings 👏 !
| The subfolder location of a model file within a larger model repository on the Hub or locally. | ||
| return_unused_kwargs (`bool`, *optional*, defaults to `False`): | ||
| Whether kwargs that are not consumed by the Python class should be returned or not. | ||
| cache_dir (`str | os.PathLike`, *optional*): |
There was a problem hiding this comment.
I wonder if removing all these args and replacing with a generic kwargs (even though it does avoid duplicating ConfigMixin.load_config), it'd make it more difficult for users to discover what they are? wdyt @sayakpaul ?
There was a problem hiding this comment.
Good point! I initially grouped them under kwargs to keep the documented arguments aligned with the explicit signature and avoid duplicating ConfigMixin.load_config. But I agree that keeping the forwarded loading options documented here is more helpful for discoverability. I’ll restore them while keeping the added type hints and Returns section.
|
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. |
What does this PR do?
This PR improves the docstrings and type hints in
src/diffusers/schedulers/scheduling_ltx_euler_ancestral_rf.py,src/diffusers/schedulers/scheduling_utils.pyandsrc/diffusers/schedulers/scheduling_vq_diffusion.pyto follow the project conventions as described in #9567.Fixes #9567
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 qualitymake fix-copiesBefore submitting
Who can review?
cc @stevhliu for review