626_privacy/tensorflow_privacy
2
0
Fork 1
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Update main README.md with pip installation directions and TF 2 announcement.

Browse source 
PiperOrigin-RevId: 336957862
This commit is contained in:
Steve Chien 2020-10-13 14:36:16 -07:00 committed by A. Unique TensorFlower
parent 1281d0c63e
commit a8aa0d5d96
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -30,7 +30,11 @@ In addition to TensorFlow and its dependencies, other prerequisites are:
### Installing TensorFlow Privacy
First, clone this GitHub repository into a directory of your choice:
If you only want to use TensorFlow Privacy as a library, you can simply execute
`pip install tensorflow-privacy`
Otherwise, you can clone this GitHub repository into a directory of your choice:
```
git clone https://github.com/tensorflow/privacy
@ -96,10 +100,12 @@ directory, but rather intended as a convenient archive.
## TensorFlow 2.x
At the moment, TensorFlow Privacy does not generally work with TensorFlow 2.x.
However, as of 2020-04-24. there is a [RFC to revamp Keras optimizers](https://github.com/tensorflow/community/pull/234)
that will enable this. Once this is done, we will update TensorFlow Privacy
as soon as possible. Thank you for your patience.
TensorFlow Privacy now works with TensorFlow 2! You can use the new
Keras-based estimators found in
`privacy/tensorflow_privacy/privacy/optimizers/dp_optimizer_keras.py`.
For this to work with `tf.keras.Model` and `tf.estimator.Estimator`, however,
you need to install TensorFlow 2.4 or later.
## Remarks