Skip to content

Commit 3bf6fb7

Browse files
authored
Update README.md
1 parent 38acb9c commit 3bf6fb7

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# netflow.js
2-
netflow.js is a javascript library for visualizing neural network structure and training on the browser.
2+
**netflow.js** is a javascript library for visualizing neural network structure and training on the browser.
33

44
The library is ment to be used for explanation purposes.
55

66
powered by [p5.js](https://p5js.org/).
77

8-
Getting Started:
8+
## Getting Started:
99

10-
netflow.js is easy to use. you need add some js files to your html file.
10+
**netflow.js** is splited into multiple js files. You need to add the js files as shown below to your html file.
1111

12+
**netflow.js** depends on [`p5.js`](https://p5js.org/) library for drawing on the html canvas.
1213

1314
```html
1415
<html>
@@ -31,6 +32,27 @@ netflow.js is easy to use. you need add some js files to your html file.
3132
</body>
3233
</html>
3334
```
35+
## Building a Neural Network
36+
37+
To build a neural network, go to `builder.js`
38+
39+
Below is a sample 3-layer (input (2), hidden (2) and output (1) ) neural network.
40+
The first added layer is always the **input** layer, while the last is the **output**. Any layer added in between is a hidden layer.
41+
42+
```javascript
43+
function build(){
44+
var net = new Net();
45+
46+
net.addLayer(2); // input
47+
net.addLayer(2); // hidden
48+
net.addLayer(1); // ouput
49+
50+
return net;
51+
52+
}
53+
54+
```
55+
56+
3457

3558

36-
`builder.js`

0 commit comments

Comments
 (0)