TensorFlow Privacy

这个代码库包含了TensorFlow Privacy的源代码,这是一个Python库,实现了用于训练具有差分隐私的机器学习模型的TensorFlow优化器。该库附带了教程和分析工具,用于计算所提供的隐私保证。

TensorFlow Privacy库正在持续开发中,随时欢迎贡献。特别是,我们一直欢迎帮助解决当前开放的问题。

最新更新

2024-02-14:从0.9.0版本开始,TensorFlow Privacy GitHub仓库将作为两个独立的PyPI包发布。第一个将继承名称tensorflow-privacy,包含与训练DP模型相关的部分。第二个,tensorflow-empirical-privacy,将包含与测试经验隐私相关的部分。

2023-02-21:现在可以为仅由Dense和Embedding层组成的DP keras模型使用新的高效逐样本梯度裁剪实现。这些模型使用了这篇论文的快速梯度计算结果。该实现应该可以在不产生任何明显的内存或运行时开销的情况下进行DP训练。它还消除了调整微批次数量的需求,因为它会针对每个样本裁剪梯度。

设置TensorFlow Privacy

依赖项

该库使用TensorFlow来定义机器学习模型。因此,安装TensorFlow(>= 1.14)是先决条件。你可以在这里找到安装说明。为了获得更好的性能,还建议安装支持GPU的TensorFlow(详细说明可在TensorFlow安装文档中找到)。

安装TensorFlow Privacy

如果你只想将TensorFlow Privacy作为库使用,可以简单地执行

pip install tensorflow-privacy

否则,你可以将此GitHub仓库克隆到你选择的目录中:

git clone https://github.com/tensorflow/privacy

然后你可以以"可编辑"模式安装本地包,以将其添加到你的PYTHONPATH:

cd privacy
pip install -e .

如果你想做出贡献,我们建议先fork仓库,然后克隆你的fork,而不是直接克隆这个仓库。

贡献

欢迎贡献!可以通过GitHub拉取请求发起错误修复和新功能。为了加快代码审查过程,我们要求:

• 在向TensorFlow Privacy贡献代码时,请在拉取请求中遵循PEP8 with two spaces编码风格(与TensorFlow使用的相同)。在大多数情况下,可以通过在已编辑的文件上运行autopep8 -i --indent-size 2 <file>来实现。

• 你还应该使用pylint和TensorFlow的pylint配置文件检查你的代码,方法是运行pylint --rcfile=/path/to/the/tf/rcfile <edited file.py>。

• 在提交第一个拉取请求时,签署Google CLA

• 我们不接受添加git子模块的拉取请求,因为维护git子模块时会出现问题

教程目录

为了帮助你开始使用该库提供的功能,我们在这里提供了详细的演练,教你如何使用TensorFlow (TF) Privacy将现有的优化器(例如SGD、Adam等)包装成它们的差分隐私对应版本。你还将学习如何调整差分隐私优化引入的参数,以及如何使用TF Privacy中包含的分析工具来衡量所提供的隐私保证。

此外,tutorials/文件夹还包含演示如何使用库功能的脚本。教程列表在教程目录中的README中有描述。

注意:教程会经过精心维护。但是,它们不被视为API的一部分,可能随时更改而不另行通知。你不应该编写导入教程的第三方代码,并期望接口不会改变。

研究目录

该文件夹包含用于重现与机器学习中隐私相关的研究论文结果的代码。它的维护不如教程目录那么仔细,而是作为一个方便的存档。

TensorFlow 2.x

TensorFlow Privacy现在可以与TensorFlow 2一起使用!你可以使用在privacy/tensorflow_privacy/privacy/optimizers/dp_optimizer_keras.py中找到的新的基于Keras的估计器。

但是,要使其与tf.keras.Model和tf.estimator.Estimator一起工作,你需要安装TensorFlow 2.4或更高版本。

备注

此仓库的内容取代了tensorflow/models仓库中的以下现有文件夹

联系方式

如果你有任何无法通过提出问题解决的疑问,请随时联系:

• Galen Andrew (@galenmandrew)
• Steve Chien (@schien1729)
• Nicolas Papernot (@npapernot)

版权

Copyright 2019 - Google LLC