pytorch / opacus

Training PyTorch models with differential privacy

https://opacus.ai

Apache License 2.0

1.68k stars 338 forks source link

added definitions for some required parameters #572

Closed sagerkudrick closed 1 year ago

sagerkudrick commented 1 year ago

added definitions for required parameters target_epsilon, target_delta, epochs. If epochs in make_private_with_epsilon differ from the number of epochs you perform, you'll incorrectly calculate noise level sigma.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[x ] Docs change / refactoring / dependency upgrade

Motivation and Context / Related issue

no reference to required parameters in docs

How Has This Been Tested (if it applies)

Checklist

[x ] The documentation is up-to-date with the changes I made.
[ x] I have read the CONTRIBUTING document and completed the CLA (see CONTRIBUTING).
[x ] All tests passed, and additional code has been covered with new tests.

facebook-github-bot commented 1 year ago

Hi @SagerKudrick!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

facebook-github-bot commented 1 year ago

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

facebook-github-bot commented 1 year ago

@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 1 year ago

@SagerKudrick has updated the pull request. You must reimport the pull request before landing.

facebook-github-bot commented 1 year ago

@SagerKudrick has updated the pull request. You must reimport the pull request before landing.

ffuuugor commented 1 year ago

@SagerKudrick Thanks for your contribution!

Can you please double check that your branch is based on the latest commit in the main branch? I can see you've added latest main commits, but it still shows as "out-of-date with the base branch"

facebook-github-bot commented 1 year ago

@SagerKudrick has updated the pull request. You must reimport the pull request before landing.

sagerkudrick commented 1 year ago

Hey @ffuuugor, this one should be good, sorry about that, I'm a little unfamiliar with this haha.

Thanks!

facebook-github-bot commented 1 year ago

@ffuuugor has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 1 year ago

@ffuuugor merged this pull request in pytorch/opacus@8f1e3d3f6df2d7dbe0779600363d3dc12a32aac7.