[docs] @auto_docstring decorator#45130
Merged
stevhliu merged 5 commits intohuggingface:mainfrom Apr 15, 2026
Merged
Conversation
|
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. |
zucchini-nlp
approved these changes
Apr 1, 2026
| title: Documenting a model | ||
| - local: model_output_tracing | ||
| title: Tracing model intermediate outputs | ||
| - isExpanded: false |
Member
There was a problem hiding this comment.
oh nice, much better indeed
This was referenced Apr 7, 2026
Merged
yonigozlan
approved these changes
Apr 9, 2026
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.
updates the
@auto_docstringdocs as part of the process of improving the model addition docsmodel.mdfile as well### Documenting argumentsis moved under## Usagebecause it makes sense they live under one roof. how to document arguments is also part of the usage guidancemodeling_model.pywas treated as the default before and there was a separate section for modular files → reframe modular files as the default since this is the standard way to add modelsBaseImageProcessor,ProcessorMixin,ModelOutputArgs)@strictdecorator## Best practiceswith a quick do/don't checklist users can quickly scan and reference