From a8aa0d5d96c0dc054d1d84bfc36d7da7c311ee6f Mon Sep 17 00:00:00 2001 From: Steve Chien Date: Tue, 13 Oct 2020 14:36:16 -0700 Subject: [PATCH] Update main README.md with pip installation directions and TF 2 announcement. PiperOrigin-RevId: 336957862 --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4fb153c..b4a0269 100644 --- a/README.md +++ b/README.md @@ -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