Skip to content

Commit af7f0cb

Browse files
authored
Update README.md
1 parent c2816dd commit af7f0cb

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
-----------------------------------------------------------------------------------------------------------
77
# Visual Machine Learning
88

9-
Visual Machine Learning contains a set of Machine Learning and Deep Learning visualisation and intuition developing tools developed using [TensorFlow.js](https://js.tensorflow.org) that can be executed directly in your browser. This project is an extension of existing ML examples from [tfjs-examples](https://github.com/tensorflow/tfjs-examples). Effort has been made to add additional features and tools to the existing ones along with newer ones.
9+
Visual Machine Learning contains a set of Machine Learning and Deep Learning interactive visualisation demos for developing intuition. These demos are developed using [TensorFlow.js](https://js.tensorflow.org) and can be executed directly in your browser. This project is an extension of ML examples from [tfjs-examples](https://github.com/tensorflow/tfjs-examples). We implement new demos, as well as, add additional features into the ones that already existed in TFJS.
1010

11-
Some examples may require web-gl enabled browsers and viewers may experience lag during executing the demos.
11+
Some examples may require web-gl enabled browsers and viewers may experience latency during executing the demos based on the device.
1212

1313
# Overview of Demos
1414

@@ -100,9 +100,9 @@ Some examples may require web-gl enabled browsers and viewers may experience lag
100100
All the examples require the following dependencies to be installed.
101101

102102
- Node.js version 8.9 or higher
103-
- [NPM cli](https://docs.npmjs.com/cli/npm) OR [Yarn](https://yarnpkg.com/en/)
103+
- [NPM CLI](https://docs.npmjs.com/cli/npm) OR [Yarn](https://yarnpkg.com/en/)
104104

105-
## How to build an example
105+
## How to build?
106106
`cd` into the directory
107107

108108
If you are using `yarn`:
@@ -124,15 +124,17 @@ npm run watch
124124

125125
The convention is that each example contains two scripts:
126126

127-
- `yarn watch` or `npm run watch`: starts a local development HTTP server which watches the
128-
filesystem for changes so you can edit the code (JS or HTML) and see changes when you refresh the page immediately.
127+
- `yarn watch` or `npm run watch`: This starts and generates a local development HTML server tracking filesystem for changes, supporting hot-reloading.
129128

130-
- `yarn build` or `npm run build`: generates a `dist/` folder which contains the build artifacts and
131-
can be used for deployment.
129+
- `yarn build` or `npm run build`: generates a `dist/` folder which contains the build artifacts and can be used for deployment.
132130

133131
## Contributing
134132

135-
If you want to contribute an example, please reach out to us on
133+
If you want to contribute a demo, please reach out to us on
136134
[Github issues](https://github.com/dsgiitr/VisualML/issues)
137135
before sending us a pull request as we are trying to keep this set of examples
138136
small and highly curated.
137+
138+
## Acknowledgements
139+
140+
* [tfjs-examples](https://github.com/tensorflow/tfjs-examples)

0 commit comments

Comments
 (0)