[docs] Fix docstring arguments that don't match the signatures - #14778
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>
|
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 |
|
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?
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