The Ultimate Guide to PyTorch Contributions - subramen/pytorch GitHub Wiki
Thank you for considering contributing to PyTorch. The contribution process for PyTorch is similar to most open source projects on Github, involving a healthy amount of open discussion between the maintainers, core developers and the broader community.
- All the ways to contribute
- Getting Started with Documentation changes
- Getting Started with Pull Requests
There are many ways to contribute to the PyTorch project, and we value them all. Most open source contributors start with small improvements, and ramp up the scale of their work as they become more familiar with the project and the community.
PyTorch has an active community of users, researchers, and developers. We tend to congregate on the PyTorch User Forum and PyTorch Developer Forum. Participating in conversations here is a great way to learn about PyTorch and contribute your expertise to the community.
PyTorch developers also engage in discussions around design and feature-level changes at the PyTorch RFC repo and Slack channel (read more).
If you are already a user of PyTorch, good places to start contributing are the PyTorch tutorials. The PyTorch tutorials are mainly authored by community members, and we always welcome new contributions or updates to existing tutorials. Learn more about contributing to PyTorch tutorials.
We aim to produce high-quality documentation, but typos or other inaccuracies may creep in. If you find something to fix or improve, please send in a pull request. The docs guide contains resources for you to start submitting documentation updates.
If you happen to run into some unexpected behavior, you can help by creating an issue (if a similar one doesn't already exist on the tracker). Use the Bug Report template and supply as much information as you can, and any additional insights/guesses you might have. See Finding or Creating Issues to get started.
Another valuable way to contribute is by reproducing open issues. Sometimes the problematic behavior may be isolated to specific environments, repro'ing it helps developers identify the cause and troubleshoot faster.
We welcome ideas for new features in PyTorch! A great way to share it with the community is by drafting an RFC (request for comments), especially if you have fleshed out the design and would like it reviewed. For more casual ideas, the Dev-Discuss forum is a good place to start.
Fixing existing issues or implementing new features require changes to the codebase. We manage merging changes via Github Pull Requests. You will need to set up your developer environment, find an issue to work upon, and submit your changes for review. The PR guide below contains resources for you to start submitting your changes to PyTorch.
As a PyTorch user, you are already a valued member of our community. Using PyTorch in your projects, examples, demos, workshops, and blogs goes a long way in raising awareness for PyTorch and the community. Please reach out to [email protected] for any support with sharing your work.
PyTorch documentation is generated from docstrings in the python source using Sphinx. This generated HTML is copied to the docs folder in the main branch of pytorch.github.io, and is then served via GitHub pages.
You need to build and install PyTorch before you can develop on the docs.
Here are some resources for developing PyTorch docs:
Here are some resources that can help you contribute pull requests:
- Install Prerequisites and Dependencies
- Fork, clone, and checkout the PyTorch source
- Build PyTorch from source
- Tips for developing PyTorch
- PyTorch Workflow Git cheatsheet