We want to make contributing to this project as easy and transparent as possible. Our goal is to provide a repo that promotes optimizer research and development separate from the official PyTorch library. Please only create pull requests for improving existing optimizers in the repo; new optimizers should be created in a separate public repo.
We actively welcome your pull requests for existing optimizers.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the 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 Meta's open source projects.
Complete your CLA here: https://code.facebook.com/cla
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.
Meta has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
- 4 spaces for indentation rather than tabs
- 80 character line length
- Please maintain a consistent style with the rest of the code
By contributing to Optimizers, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.