Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pytorch/hub
Submission to https://pytorch.org/hub/
https://github.com/pytorch/hub
Last synced: 29 days ago
JSON representation
Submission to https://pytorch.org/hub/
- Host: GitHub
- URL: https://github.com/pytorch/hub
- Owner: pytorch
- Created: 2019-04-22T16:51:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T17:43:13.000Z (12 months ago)
- Last Synced: 2024-01-25T19:08:22.286Z (9 months ago)
- Language: Python
- Homepage:
- Size: 25.2 MB
- Stars: 1,346
- Watchers: 230
- Forks: 248
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-pytorch-list-CNVersion - hub
- awesome-list - TorchHub - Model zoo for PyTorch (Deep Learning Framework / High-Level DL APIs)
- Awesome-pytorch-list - hub - trained model repository designed to facilitate research reproducibility. (Pytorch & related libraries / Other libraries:)
- awesome - pytorch/hub - Submission to https://pytorch.org/hub/ (Python)
README
# PyTorch Hub
[](https://circleci.com/gh/pytorch/hub)
## Logistics
We accept submission to PyTorch hub through PR in `hub` repo. Once the PR is merged into master here, it will show up on the [PyTorch website](https://pytorch.org/hub) in 24 hrs.
## Steps to submit to PyTorch hub
1. Add a `hubconf.py` in your repo, following the instruction in [torch.hub doc](https://pytorch.org/docs/master/hub.html#publishing-models). Verify it's working correctly by running `torch.hub.load(...)` locally.
2. Create a PR in `pytorch/hub` repo. For each new model you have, create a `__.md` file using this [template](docs/template.md).
### Notes
- Currently we don't support hosting pretrained weights, users with pretrained weights need to host them properly themselves.
- In general we recommend one model per markdown file, models with similar structures like `resnet18, resnet50` should be placed in the same file.
- If you have images, place them in `images/` folder and link them correctly in the `[images/featured_image_1/featured_image_2]` fields above.
- We only support a pre-defined set of tags, currently they are listed in [scripts/tags.py](scripts/tags.py). We accept PRs to expand this set as needed.
- To test your PR locally, run the tests below.
```
python scripts/sanity_check.py
./scripts/run_pytorch.sh
```
- Our CI concatenates all python code blocks in one markdown file and runs it against the latest PyTorch release.
- Remember to mark your python code using ```` ```python```` in your model's markdown file.
- If your `dependencies` are not installed on our CI machine, add them in [install.sh](scripts/install.sh).
- If it fails, you can find a new `temp.py` file left in the repo to reproduce the failure.
- We also provide a way to preview your model webpage through `netlify bot`. This bot builds your PR with the latest `pytorch.github.io` repo and comments on your PR with a preview link. The preview will be updated as you push more commits to the PR.
