[WIP]Shrestha/update readme option3 #235
Conversation
…rol slots and control slots must only be linked to control slots
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
…ervanaSystems/ngraph-tf into shrestha/Update_Readme_Option3
shresthamalik
changed the title
| @@ -1,33 +1,57 @@ | |||
| # Intel® nGraph™ Compiler and runtime for TensorFlow* | |||
| # nGraph-Tensorflow : Intel® nGraph™ Compiler and Runtime for TensorFlow | |||
|
|
|||
There was a problem hiding this comment.
nGraph-Tensorflow is the name of this too: https://github.com/NervanaSystems/ngraph-tensorflow
But I suppose it is clear from the context which is which.
@avijit-nervana ?
There was a problem hiding this comment.
That repo will likely be retired at some point so I'm not sure it matters too much, but I think nGraph-TensorFlow is still a little confusing. To me it kind of sounds like a fork of TensorFlow, which is not what ngraph-tf is.
There was a problem hiding this comment.
Yes, it would be nice to have a name for the repo. Earlier, we were referencing it as 'ngraph-tensorflow bridge'. Bridge is more of an internal usage, so we removed it. Our current version, does not explicitly call out a name but at many places we reference 'ngraph-tf bridge'. Requires more brainstorming.
There was a problem hiding this comment.
@sayantan-nervana That repo is now private - so won't matter much. I agree with @shresthamalik that it needs more brainstorming. For now I would recommend not introducing this.
| @@ -1,33 +1,57 @@ | |||
| # Intel® nGraph™ Compiler and runtime for TensorFlow* | |||
| # nGraph-Tensorflow : Intel® nGraph™ Compiler and Runtime for TensorFlow | |||
|
|
|||
There was a problem hiding this comment.
@sayantan-nervana That repo is now private - so won't matter much. I agree with @shresthamalik that it needs more brainstorming. For now I would recommend not introducing this.
| customize and deploy Deep Learning inference models that will "just work" with | ||
| a variety of nGraph-enabled backends: CPU, GPU, and custom silicon like the | ||
| [Intel® Nervana™ NNP](https://itpeernetwork.intel.com/inteldcisummit-artificial-intelligence/). | ||
| nGraph-Tensorflow (ngraph-tf) enables TensorFlow to run with [Intel® nGraph™](https://github.com/NervanaSystems/ngraph), compiler and |
There was a problem hiding this comment.
I would recommend keeping this as is.
README.md
Outdated
|
|
||
| #### Installation | ||
|
|
||
| 1. Once TensorFlow's dependencies are installed, clone the source of the | ||
| [tensorflow] repo to your machine. | ||
| 1. Install [bazel](#install-bazel-for-building-tensorflow-source) and other TensorFlow dependencies. Now, clone the source of the [tensorflow] repo to your machine. | ||
|
|
||
| :warning: You need the following version of TensorFlow: `v1.11.0-rc2` |
There was a problem hiding this comment.
Please update this to point to v1.11.0
README.md
Outdated
| @@ -88,18 +95,7 @@ The installation prerequisites are the same as described in the TensorFlow | |||
| git status | |||
| HEAD detached at v1.11.0-rc2 | |||
|
|
||
| ### Option 1: Build nGraph using an existing TensorFlow installation | ||
|
|
||
| 1. Create and activate a [python virtual environment](#create-a-python-virtual-environment) | ||
|
|
||
| 2. Install TensorFlow v1.11.0-rc2. Note that this is a pre-release so you need | ||
| to use the following steps to install this: |
There was a problem hiding this comment.
Now we are at 1.11, so may need to change all instances of 1.11-rc2 to 1.11
| @@ -149,12 +145,12 @@ The installation prerequisites are the same as described in the TensorFlow | |||
| git checkout v0.6.1 | |||
|
|
|||
|
|
|||
| 7. Next, build and install nGraph bridge. | |||
| 7. Next, build and install nGraph-tf. | |||
There was a problem hiding this comment.
step 6: Now clone the ngraph-tfrepo one level above -- in the *parent* directory of thetensorflow repo cloned in step 1
this requirement is probably no longer there.
Updated the Readme: