Skip to content

Commit

Permalink
Padding on the research folder (D67400804) (#705)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #705

Slightly change the language of the ``readme``.

Reviewed By: iden-kalemaj

Differential Revision: D67520069

fbshipit-source-id: ee8ac1b878daa78270ef8c145a339a917de899bb
  • Loading branch information
HuanyuZhang authored and facebook-github-bot committed Dec 20, 2024
1 parent ed1bd0b commit b3c390e
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions research/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,10 @@ We warmly welcome and encourage contributions of new methods! To contribute, ple
1. Fork the repo and create your branch from `main`.
2. Place the new method in a separate subfolder within the `research` directory.
3. The new folder should include a `README.md` that explains the method at a high level, demonstrates usage (e.g., introducing new parameters to the `PrivacyEngine`), and cites relevant sources. The subfolder name should aptly represent the method.
4. If you have added code that should be tested, add unit tests.
5. If you have changed APIs, document the API change in the PR. Also update the documentation and make sure the documentation builds.
6. Ensure the test suite passes.
7. Make sure your code passes both `black` and `flake8` formatting checks.

More detailed PR instructions can be found [here](https://github.com/pytorch/opacus/blob/main/CONTRIBUTING.md).

Feel free to reach out with any questions about the process or to discuss whether your method is a good fit for the repository.

## Notes
Please note that the code provided in this directory will not be maintained by the Opacus team, which may lead to compatibility issues with future changes. If you have any questions, please reach out to the PR contributor.
Please note that the code provided in this directory will not be maintained by the Opacus team, which may lead to compatibility issues with future changes. If you have any questions, please reach out to the PR contributor directly.

0 comments on commit b3c390e

Please sign in to comment.