Skip to content

Commit

Permalink
Adding installation instructions to README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
pavithrasv committed Apr 1, 2020
1 parent 9cdf0f3 commit 48dd52c
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
@@ -1,11 +1,33 @@
# TensorFlow Cloud

<h2>What is this repo?</h2>
## What is this repo?

This repository provides APIs that will allow to easily go from debugging and training your Keras and TensorFlow code in a local environment to distributed training in the cloud.

## Installation

## Usage
### Requirements:

- Python >= 3.5
- [Set up your Google Cloud project](https://cloud.google.com/ai-platform/docs/getting-started-keras#set_up_your_project)
- [Authenticate your GCP account](https://cloud.google.com/ai-platform/docs/getting-started-keras#authenticate_your_gcp_account)


### Install latest release:

```
pip install -U tensorflow-cloud
```

### Install from source:

```
git clone https://github.com/tensorflow/cloud.git
cd cloud
pip install .
```

## Usage examples

- [Usage with `tf.keras` script that trains using `model.fit`](tests/integration/call_run_on_script_with_keras_fit.py).
- [Usage with `tf.keras` script that trains using a custom training loop](tests/integration/call_run_on_script_with_keras_ctl.py).
Expand Down

0 comments on commit 48dd52c

Please sign in to comment.