Kevin Murphy, Mahmoud Soliman and Zeel B Patel.
Last updated: 2022-05-03.
We'd love to accept your patches and contributions to this project. This project follows Google's Open Source Community Guidelines.
Contributions to this project means that the contributors agree to releasing the contributions under the MIT license.
- Follow standard Python style guidelines. In particular, follow PEP8 naming conventions.
- See this list of python tutorials for more guidelines.
- Use JAX instead of numpy/scipy.
- If you need to use a neural network, use Flax instead of PyTorch/TF.
- Follow standard github guidelines on pull requests.
- In general, your commit should be in response to an open issue. If you want to add something new, please open an issue first. Some issues are quite large, so you may want to create smaller issues you can tackle individually, and link these to the main one.
- If you want to tackle an open issue, please reply to the issue to indicate your interest, and add a link to any design docs or partial solutions.
- Do not submit multiple draft PRs - work on one issue at a time.
- If your pull request refers to an open issue, please be sure to mention it using the issue keyword.
- When the code is ready, request a review from @murphyk, @mjsML and @gerdm; one of us will get back to you within 1-2 days.
- Make sure your pull request has only one commit (We will squash the commits anyway, however github still emails all people following the repo for every single commit!).
- Please use github public gists to share the figures that your code generates, so we can quickly “eyeball” them. Include these gists in your PR.
- Look at this example for how to format your PR.
- If your code is in a notebook stored in your forked copy of the repo, please include a link to it in your PR (similar to this example