Add docstrings to new HUB functions #7576
Merged
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.
@kalenmike @hassaanfarooq01 this PR adds single-line docstrings to the newly introduced functions that are lacking them.
Every function within our open-source repositories must be accompanied by at least a single-line docstring. These will also render within the Docs reference section in addition to the code.
EDIT: Also note that a lines that start with
#
are not actually docstrings and will be ignored by MkDocs and other tools. Instead the docstring, even if it's single-line, must start and end with"""
π οΈ PR Summary
Made with β€οΈ by Ultralytics Actions
π Summary
Improving documentation and code clarity for model handling in the Ultralytics Hub.
π Key Changes
load_model
,create_model
,_set_train_args
,_parse_identifier
,retry_request
, and_should_retry
functions.π― Purpose & Impact