2020-01-14 17:49:00 -08:00
# Contributing to examples
We want to make contributing to this project as easy and transparent as
possible.
## Pull Requests
We actively welcome your pull requests.
2022-03-09 17:25:02 -08:00
If you're new we encourage you to take a look at issues tagged with [good first issue ](https://github.com/pytorch/examples/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 )
2022-03-09 17:00:01 -08:00
### For new examples
0. Create a github issue proposing a new example and make sure it's substantially different from an existing one
2022-03-09 09:13:32 -08:00
1. Fork the repo and create your branch from `main` .
2022-03-09 17:00:01 -08:00
2. If you've added code that should be tested, add tests to `run_python_examples.sh`
2022-04-22 12:27:43 -07:00
3. Create a `README.md` .
4. Add a card with a brief description of your example and link to the repo to
the `docs/source/index.rst` file and build the docs by running:
```
cd docs
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
make html
` ``
When done working with ` virtualenv`, run ` deactivate`.
5. Verify that there are no issues in your doc build. You can check preview locally
by installing [sphinx-serve](https://pypi.org/project/sphinx-serve/) and
2022-05-07 19:14:48 -07:00
then running ` sphinx-serve -b build`.
2022-04-22 12:27:43 -07:00
5. Ensure your test passes locally
6. If you haven't already, complete the Contributor License Agreement ("CLA").
7. Address any feedback in code review promptly
2022-03-09 17:00:01 -08:00
## For bug fixes
1. Fork the repo and create your branch from ` main`.
2022-04-19 15:22:25 -04:00
2. Make sure you have a GPU-enabled machine, either locally or in the cloud. ` g4dn.4xlarge` is a good starting point on AWS.
3. Make your code change.
4. First, install all dependencies with ` ./run_python_examples.sh "install_deps"`
5. Then make sure that ` ./run_python_examples.sh` passes locally by running script end to end.
6. If you haven't already, complete the Contributor License Agreement ("CLA").
7. Address any feedback in code review promptly
2022-03-09 17:00:01 -08:00
2020-01-14 17:49:00 -08:00
## Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need
to do this once to work on any of Facebook's open source projects.
Complete your CLA here: <https://code.facebook.com/cla>
## Issues
We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.
## License
By contributing to examples, you agree that your contributions will be licensed
2022-03-09 09:13:32 -08:00
under the LICENSE file in the root directory of this source tree.
