Giter VIP home page Giter VIP logo

hub's Introduction

PyTorch Hub

CircleCI

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 in 24 hrs.

Steps to submit to PyTorch hub

  1. Add a hubconf.py in your repo, following the instruction in torch.hub doc. 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 <repo_owner>_<repo_name>_<title>.md file using this template.

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. 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.
    • 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. Example netlify bot comment

hub's People

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.