Skip to content

hub doc improvements #21307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ailzhang wants to merge 1 commit into from
Closed

hub doc improvements #21307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/source/hub.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,16 @@ You can see the full script in
return model


- ``dependencies`` variable is a **list** of package names required to to run the model.
- ``dependencies`` variable is a **list** of package names required to **load** the model. Note this might
be slightly different from dependencies required for training a model.
- ``args`` and ``kwargs`` are passed along to the real callable function.
- Docstring of the function works as a help message. It explains what does the model do and what
are the allowed positional/keyword arguments. It's highly recommended to add a few examples here.
- Entrypoint function should **ALWAYS** return a model(nn.module).
- Pretrained weights can either be stored locally in the github repo, or loadable by
``torch.hub.load_state_dict_from_url()``. In the example above ``torchvision.models.resnet.resnet18``
handles ``pretrained``, alternatively you can put the following logic in the entrypoint definition.
- Callables prefixed with underscore are considered as helper functions which won't show up in ``torch.hub.list()``.

::

Expand Down Expand Up @@ -93,6 +95,10 @@ A suggested workflow is
- ``dir(model)`` to see all avaialble methods of the model.
- ``help(model.foo)`` to check what arguments ``model.foo`` takes to run

To help users explore without refering to documentation back and forth, we strongly
recommend repo owners make function help messages clear and succinct. It's also helpful
to include a minimal working example.

Where are my downloaded models saved?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down