From 1214589eb2c702c49ab42085f379bbda83372b8c Mon Sep 17 00:00:00 2001 From: Shanqing Cai Date: Sat, 17 Mar 2018 23:41:24 -0400 Subject: [PATCH 1/4] Improve README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 41d21c5049b..c3037ae4418 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# tfjs +# TensorFlow.js: Union Package + +A part of the [TensorFlow](https://www.tensorflow.org) ecosystem, +TensorFlow.js is a library for web browser-based machine learning using +JavaScript or TypeScript. It enables building, loading, executing and training +machine learning models in the browser, powered by WebGL acceleration. + +This repository contains the logic and scripts to form a **union** package, +[@tensorflowjs/tfjs](https://www.npmjs.com/package/@tensorflow/tfjs), from + +- [TensorFlow.js Core](https://github.com/tensorflow/tfjs-core), + a flexible low-level API, formerly known as *deeplearn.js*. +- [TensorFlow.js Layer](https://github.com/tensorflow/tfjs-layers), + a high-level API modeled after [Keras](https://keras.io/). + +For more information on the APIs, follow the links to their respective +repositories, or visit [js.tensorflow.org](https://js.tensorflow.org). \ No newline at end of file From 631ae132d6aea194fe13cdcbc0231bc59e0d48e0 Mon Sep 17 00:00:00 2001 From: Shanqing Cai Date: Sat, 17 Mar 2018 23:53:20 -0400 Subject: [PATCH 2/4] Layer -> Layers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c3037ae4418..3e111bdf336 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repository contains the logic and scripts to form a **union** package, - [TensorFlow.js Core](https://github.com/tensorflow/tfjs-core), a flexible low-level API, formerly known as *deeplearn.js*. -- [TensorFlow.js Layer](https://github.com/tensorflow/tfjs-layers), +- [TensorFlow.js Layers](https://github.com/tensorflow/tfjs-layers), a high-level API modeled after [Keras](https://keras.io/). For more information on the APIs, follow the links to their respective From dd073108155d74ad32b8dca1a689be21a631e3e2 Mon Sep 17 00:00:00 2001 From: Shanqing Cai Date: Sun, 18 Mar 2018 10:32:40 -0400 Subject: [PATCH 3/4] Response to Daniel's comments --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3e111bdf336..dea3e6b856b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # TensorFlow.js: Union Package A part of the [TensorFlow](https://www.tensorflow.org) ecosystem, -TensorFlow.js is a library for web browser-based machine learning using -JavaScript or TypeScript. It enables building, loading, executing and training -machine learning models in the browser, powered by WebGL acceleration. +TensorFlow.js is a machine learning framework for JavaScript developers. +It supports building, training and serving machine learning models in the +browser using WebGL acceleration. You can also import pre-trained TensorFlow +[SavedModels](https://www.tensorflow.org/programmers_guide/saved_model) and +[Keras models](https://keras.io/getting-started/faq/#how-can-i-save-a-keras-model), +for execution and retraining in the browser. + +For more information on the API, follow the links to their Core and Layers +repositories below, or visit [js.tensorflow.org](https://js.tensorflow.org). This repository contains the logic and scripts to form a **union** package, [@tensorflowjs/tfjs](https://www.npmjs.com/package/@tensorflow/tfjs), from @@ -12,6 +18,3 @@ This repository contains the logic and scripts to form a **union** package, a flexible low-level API, formerly known as *deeplearn.js*. - [TensorFlow.js Layers](https://github.com/tensorflow/tfjs-layers), a high-level API modeled after [Keras](https://keras.io/). - -For more information on the APIs, follow the links to their respective -repositories, or visit [js.tensorflow.org](https://js.tensorflow.org). \ No newline at end of file From dd25b7852241a29e627daf309163c0841cb132a1 Mon Sep 17 00:00:00 2001 From: Shanqing Cai Date: Sun, 18 Mar 2018 10:54:15 -0400 Subject: [PATCH 4/4] Respond to Nikhil's comments --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dea3e6b856b..5be3f986b3e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # TensorFlow.js: Union Package -A part of the [TensorFlow](https://www.tensorflow.org) ecosystem, -TensorFlow.js is a machine learning framework for JavaScript developers. -It supports building, training and serving machine learning models in the -browser using WebGL acceleration. You can also import pre-trained TensorFlow +TensorFlow.js is a JavaScript library for building, training and serving +machine learning models. When running in the browser, it utilizes WebGL +acceleration. TensorFlow.js is a part of the +[TensorFlow](https://www.tensorflow.org) ecosystem. +You can import pre-trained TensorFlow [SavedModels](https://www.tensorflow.org/programmers_guide/saved_model) and [Keras models](https://keras.io/getting-started/faq/#how-can-i-save-a-keras-model), -for execution and retraining in the browser. +for execution and retraining. For more information on the API, follow the links to their Core and Layers repositories below, or visit [js.tensorflow.org](https://js.tensorflow.org).