A fast algorithm to optimally compose privacy guarantees of differentially private (DP) mechanisms to arbitrary accuracy.
Перейти к файлу
Lukas Wutschitz d83df3af60
Fix github tag to point to latest release (#24)
Co-authored-by: Lukas Wutschitz <lukas.wutschitz@microsoft.com>
2021-11-10 18:56:31 +00:00
.github/workflows Add workflow for windows (#9) 2021-09-08 16:36:41 +01:00
bin Move RDP computation to PRV and tidy up dependencies (#13) 2021-10-20 11:06:17 -05:00
notebooks Use more suitable argument names (#2) 2021-06-18 17:50:07 +01:00
prv_accountant Add a test to check that not more compositions than max_compositions is requested (#21) 2021-11-10 15:00:49 +00:00
tests Add a test to check that not more compositions than max_compositions is requested (#21) 2021-11-10 15:00:49 +00:00
.gitignore Initial commit 2021-06-09 09:09:43 +00:00
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md committed 2021-06-09 02:09:51 -07:00
LICENSE LICENSE committed 2021-06-09 02:09:51 -07:00
README.md Update readme (#11) 2021-09-07 12:42:20 +01:00
SECURITY.md SECURITY.md committed 2021-06-09 02:09:52 -07:00
SUPPORT.md Initial PR (#1) 2021-06-11 20:08:05 +01:00
setup.py Fix github tag to point to latest release (#24) 2021-11-10 18:56:31 +00:00

README.md

Privacy Random Variable (PRV) Accountant

A fast algorithm to optimally compose privacy guarantees of differentially private (DP) algorithms to arbitrary accuracy. Our method is based on the notion of privacy loss random variables to quantify the privacy loss of DP algorithms. For more details see [1].

Installation

pip install prv-accountant

Examples

Getting epsilon estimate directly from the command line.

compute-dp-epsilon --sampling-probability 5e-3 --noise-multiplier 0.8 --delta 1e-6 --num-compositions 1000

Or, use it in python code

from prv_accountant import Accountant

accountant = Accountant(
	noise_multiplier=0.8,
	sampling_probability=5e-3,
	delta=1e-6,
	eps_error=0.1,
	max_compositions=1000
)

eps_low, eps_estimate, eps_upper = accountant.compute_epsilon(num_compositions=1000)

For more examples, have a look in the notebooks directory.

References

[1] Sivakanth Gopi, Yin Tat Lee, Lukas Wutschitz. Numerical Composition of Differential Privacy. arXiv. Preprint posted online June 5, 2021. arXiv

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.