Skip to content

Commit

Permalink
Merge pull request #57 from abhisheksoni27/patch-1
Browse files Browse the repository at this point in the history
Change package name
  • Loading branch information
DanRuta committed May 4, 2018
2 parents 150199e + 2806544 commit b17bf7e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@ weights[0] = 1
net.layers[1].neurons[0].weights = weights
```

Note that you need to serve files via a server (a basic server is an included) to load WebAssembly into a browser.
Note that you need to serve files via a server (a basic server is included) to load WebAssembly into a browser.

### As an NPM package
To install jsNet, run ```npm install jsNet```. You can choose which version you want to use at runtime. When ```require```-ing the package, you need to call the appropriate version, like so:
To install jsNet, run ```npm install jsnet```. You can choose which version you want to use at runtime. When ```require```-ing the package, you need to call the appropriate version, like so:

#### JavaScript
```javascript
const {Network, FCLayer} = require("jsNet").js()
const {Network, FCLayer} = require("jsnet").js()
```

#### WebAssembly
```javascript
const {Module, Network, FCLayer} = require("jsNet").webassembly()
const {Module, Network, FCLayer} = require("jsnet").webassembly()
```
When loading the WebAssembly version, you also need to use the Module object. This is the compiled emscripten WebAssembly object which binds your code to the C++ code. If you change the file structure, read below on how to load manually.

Expand Down Expand Up @@ -161,7 +161,7 @@ You can call the `net.delete()` function when using the WebAssembly version to c
I will use [the MNIST dataset](https://github.com/cazala/mnist) in the examples below.

```javascript
const {Network, Layer, FCLayer, ConvLayer, PoolLayer, Filter, Neuron, NetMath, NetUtil} = require("jsNet").js()
const {Network, Layer, FCLayer, ConvLayer, PoolLayer, Filter, Neuron, NetMath, NetUtil} = require("jsnet").js()
// Get just what you need.
```
Layer is an alias for FCLayer, for people not using the library for convolutional networks.
Expand Down

0 comments on commit b17bf7e

Please sign in to comment.