Skip to content

Commit 535e5bf

Browse files
committed
Update README.md
1 parent 7dfb1a0 commit 535e5bf

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ml5-neuralnetwork-test-build
2-
This repo is a test to see what it would take to create a new build for ml5.
2+
This repo is a test to see what it would take to build only the NeuralNetwork feature of the ml5 library.
33

44
## Setup
55
This build uses node version 18.15.0 and npm version.
@@ -16,10 +16,10 @@ cd package
1616
npm install
1717
npm run build
1818
```
19-
This will create a build in the dist folder.
19+
This will create the build in the dist folder.
2020

2121

22-
Open `test/index.html` in the browser to see the build working, running an example from the ml5 website.
22+
Open `test/index.html` in the browser to see the build running an example from the ml5 website.
2323

2424

2525
## Process
@@ -34,6 +34,4 @@ I also created package.json using `npm init` and set up a basic config file for
3434
From the original ml5 library's `src` folder, I copied over all source files from the `NeuralNetwork` directory and necessary dependency files from `utils` directory. I also copied over `index.js` from the `src` folder and deleted everything unrelated to NeuralNetwork. I then installed `@tensorflow/[email protected]`, `@tensorflow/[email protected]`, and `[email protected]` with npm.
3535

3636

37-
At this point, the library can be built without error. I was only getting an error about exceeding recommended size limit. For the build, I am using the latest version of node and all the npm dependencies. It seems like NeuralNetwork does not have any problems with that.
38-
39-
37+
At this point, the library can be built without error. I was only getting an error about exceeding recommended size limit. For the build, I am using the latest version of node, npm, and tfjs. I have not tested all the features of NeuralNetwork, but it appears to be working just fine.

0 commit comments

Comments
 (0)