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.

If you are new , we encourage you to take a look at issues tagged with good first issue

Create a Github issue proposing a new example and make sure it's substantially different from an existing one.
Fork the repo and create your branch from main.
If you have added code that should be tested, add tests to run_python_examples.sh.
Create a README.md.
Add a card with brief description of your example and link to the repo to 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.
Verify that there are no issues in your doc build. You can check the preview locally by installing sphinx-serve then running sphinx-serve -b build.
Ensure your test passes locally.
If you haven't already, complete the Contributor License Agreement("CLA").
Address any feedback in code review promptly.

Fork the repo and create your branch from main.
Make sure you have a GPU-enabled machine, either locally or in the cloud. `g4dn.4xlarge' is a good starting point on AWS.
Make your code change.
First, install all dependencies with ./run_python_examples.sh "install_deps".
Then, make sure that ./run_python_examples.sh passes locally by running the script end to end.
If you haven't already, complete the Contributor License Agreement ("CLA").
Address any feedback in code review promptly.

To accept your pull request, we need to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

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.

By contributing to examples, you agree that your contributions will be licensed under the LICENSE file in the root direactory of this source tree.