Skip to content

Commit

Permalink
update readme and release note
Browse files Browse the repository at this point in the history
  • Loading branch information
Parallels committed Apr 27, 2020
1 parent 6d9c194 commit 9fc8119
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ The current version integerates the secure multi-party computation protocols for

## Installation

For now, Rosetta runs on Ubuntu 18.04, and is based on TensorFlow 1.14 with CPUs. Windows is not currently supported. In short, It takes the following 3 steps to install Rosetta.
For now, Rosetta runs on Ubuntu 18.04, and is based on TensorFlow 1.14 with CPUs. Windows is not currently supported. Install Rosetta as follows.

First, you shoud check that your local system meets our base enviroment requirement.
Please check that your local system meets our base enviroment requirement.

And then, install the native TensorFlow. You can either install it from its source code or with the help of Python's `pip` package manager. The easiest way to do this is just as follows:
Install the native TensorFlow with the following codes. Note that you could also install it from source code, check [here](doc/TENSORFLOW_INSTALL.md) for details.
```bash
# install tensorflow
pip3 install tensorflow==1.14.0
````

The last step is to build and install Rosetta from source code. We have provided an all-in-one script to ease the process. All you need to do is:
Build and install Rosetta with our all-in-one script as follows.

```bash
# clone rosetta git repository
Expand All @@ -36,7 +36,7 @@ cd Rosetta
bash compile_and_test_all.sh
````
After installation, you can use an example to check everything runs OK. Please refer to [Deployment Guide](doc/DEPLOYMENT.md) for the detailed steps of configuration, installation and deployment of Rosetta.
You could use an example to check everything runs OK. Please refer to [Deployment Guide](doc/DEPLOYMENT.md) for the detailed steps of configuration, installation and deployment of Rosetta.
## Usage
The following is a simple example for the famous Millionaires' problem using Rosetta.
Expand Down
4 changes: 4 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
## Introduction
This document will maintain and continually update the release notes of each version of Rosetta. If you have questions or comments, please contact us via [email protected].

## Rosetta v0.1.1

### Features
1. Binary intallation of TensorFlow is supported.

## Rosetta v0.1.0

Expand Down

0 comments on commit 9fc8119

Please sign in to comment.