Skip to content

Commit

Permalink
Increment the version and add release documentation.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 234727703
  • Loading branch information
michaelreneer authored and tensorflower-gardener committed Feb 20, 2019
1 parent 7fe4808 commit c76a3a8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
3 changes: 3 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Release 0.1.0

Initial public release.
28 changes: 22 additions & 6 deletions tensorflow_federated/tools/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,38 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""TensorFlow Federated is an open source federated learning framework.
# pylint: disable=line-too-long
"""TensorFlow Federated is an open-source federated learning framework.
TensorFlow Federated is a framework for implementing federated learning
algorithms and other computations on privacy-sensitive decentralized data.
TensorFlow Federated (TFF) is an open-source framework for collaborative
computations on distributed data that does not require collecting data at a
centralized location.
TODO(b/112658581): Add TFF high level overview.
The framework has initially been developed to facilitate open research and
experimentation with
[Federated Learning](https://ai.googleblog.com/2017/04/federated-learning-collaborative.html),
a technology that enables devices owned by end users to collaboratively learn a
shared prediction model while keeping potentially sensitive training data on the
devices, thus decoupling the ability to do machine learning from the need to
collect and store the data in the cloud.
With the interfaces provided by TFF, developers can test existing federated
learning algorithms on their models and data, or design new experimental
algorithms and run them on existing models and data, all within the same open
source environment. The framework has been designed with compositionality in
mind, and can be used to combine independently-developed techniques and
components that offer complementary capabilities into larger systems.
"""
# pylint: enable=line-too-long
# TODO(b/124800187): Keep in sync with the contents of README.

import sys

import setuptools

DOCLINES = __doc__.split('\n')

# Set when releasing a new version of TensorFlow Federated (e.g. 1.0.0).
_VERSION = '0.0.0'
_VERSION = '0.1.0'

project_name = 'tensorflow_federated'

Expand Down

0 comments on commit c76a3a8

Please sign in to comment.