[docs] Fix docstring arguments that don't match the signatures - #14778
Open
revanth-045 wants to merge 1 commit into
Open
revanth-045 wants to merge 1 commit into
revanth-045 wants to merge 1 commit into
Conversation
- TransformerSpatioTemporalModel.forward: no num_frames parameter - get_2d_rotary_pos_embed_lumina: parameters are len_h / len_w, not grid - AutoencoderKLHunyuanImageRefiner / AutoencoderKLHunyuanVideo15.tiled_decode: no return_dict parameter; they return a plain tensor Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Hi @revanth-045, thanks for the PR! It does not appear to link an issue it fixes. If this PR addresses an existing issue, please add a closing keyword (e.g. Please note that PRs without a linked issue are likely to be automatically closed 10 days after this notice. Once the PR links an issue (or gets the |
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.
What does this PR do?
Four public docstrings describe parameters the functions don't accept (or a return type they don't produce), so the rendered API docs mislead callers:
TransformerSpatioTemporalModel.forwardnum_frames (int)image_only_indicator)get_2d_rotary_pos_embed_luminagrid (np.ndarray)len_h,len_w(now documented)AutoencoderKLHunyuanImageRefiner.tiled_decodereturn_dict; returnsDecoderOutputortuplereturn_dict; returnstorch.Tensor)AutoencoderKLHunyuanVideo15.tiled_decodereturn_dict; returnsDecoderOutputortuplereturn_dict; returnstorch.Tensor)Docstring-only; no behaviour changes. None of the touched blocks are
# Copied fromtargets.ruff check,ruff format --check, anddoc-builder style --check_onlypass on the changed files.Before submitting
🤖 Generated with Claude Code