[docs] Follow ups for consistent forward docstrings#13779
Merged
Conversation
…13830) Adds a Returns: section to the 43 model forward() and pipeline __call__() methods flagged by utils/check_forward_call_docstrings.py, which requires a Returns: section whenever the method has a non-None return annotation. Descriptions reflect the actual return statements (Output dataclass when return_dict=True, plain tuple otherwise; bare tensors / lists where applicable) and reuse each file's existing doc-builder link form. Also reformats a malformed single-line Returns: in pipeline_aura_flow.py that the check could not detect. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Member
Author
|
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
Author
|
@bot /style |
Contributor
|
Style bot fixed some files and pushed the changes. |
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
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?
Follow ups from #13758 that added utilities in our CI to enforce some consistency in the
forward()andcall()methods ofXXXModelandXXXPipelineclasses, respectively. This PR:I didn't implement placeholders because they tend to go unnoticed over time.
There will be some failures in our current CI because some classes don't document return types properly. We will fix those in a PR basing off of this branch. @stevhliu could you look into that?