@nlpjs/neural - npm Package Compare versions

Comparing version 4.11.0 to 4.12.0

package.json

 {
   "name": "@nlpjs/neural",
-  "version": "4.11.0",
+  "version": "4.12.0",
   "description": "Neural Network",
@@ -27,6 +27,3 @@ "author": {
   },
-  "dependencies": {
-    "@nlpjs/core": "^4.11.0"
-  },
-  "gitHead": "9b24db3f2a381399cad134bdab734e36744fcde1"
+  "gitHead": "381e2a74ebbb634ba944cf05355232d580189a78"
 }

README.md

@@ -1,11 +0,159 @@
-# `neural`
+![NLPjs logo](screenshots/nlplogo.gif)
 
-> TODO: description
+# NeuralNetwork
 
-## Usage
+## Introduction
 
+_NeuralNetwork_ is the class for an NLU Neural Network, able to train a classifier and then classify into intents.
+This package is part of the NLP.js suite.
+
+## Installing
+
+_NeuralNetwork_ is a class of the package _@nlpjs/neural_, that you can install via NPM:
+
+```bash
+  npm install @nlpjs/neural
+```
+
+## Corpus Format
+
+For training the classifier you need a corpus. The corpus format is an array of objects where each object contains an input and output, where the input is an object with the features and the output is an object with the intents:
+
+```json
+[
+  {
+    "input": { "who": 1, "are": 1, "you": 1 },
+    "output": { "who": 1 }
+  },
+  {
+    "input": { "say": 1, "about": 1, "you": 1 },
+    "output": { "who": 1 }
+  },
+  {
+    "input": { "why": 1, "are": 1, "you": 1, "here": 1 },
+    "output": { "who": 1 }
+  },
+  {
+    "input": { "who": 1, "developed": 1, "you": 1 },
+    "output": { "developer": 1 }
+  },
+  {
+    "input": { "who": 1, "is": 1, "your": 1, "developer": 1 },
+    "output": { "developer": 1 }
+  },
+  {
+    "input": { "who": 1, "do": 1, "you": 1, "work": 1, "for": 1 },
+    "output": { "developer": 1 }
+  },
+  {
+    "input": { "when": 1, "is": 1, "your": 1, "birthday": 1 },
+    "output": { "birthday": 1 }
+  },
+  {
+    "input": { "when": 1, "were": 1, "you": 1, "borned": 1 },
+    "output": { "birthday": 1 }
+  },
+  {
+    "input": { "date": 1, "of": 1, "your": 1, "birthday": 1 },
+    "output": { "birthday": 1 }
+  }
+]
+```
+
+## Example of use
+
+The file _corpus.json_ should contain the corpus shown in the Corpus Format section for this example.
+This will train this corpus and run the input equivalent to the sentence "when birthday". 
+The result is each intent with the score for this intent.
+
 ```javascript
-const neural = require('neural');
+const { NeuralNetwork } = require('@nlpjs/neural');
+const corpus = require('./corpus.json');
 
-// TODO: DEMONSTRATE API
+const net = new NeuralNetwork();
+net.train(corpus);
+console.log(net.run({ when: 1, birthday: 1 }));
+// { who: 0, developer: 0, birthday: 0.7975805386427789 }
 ```
+
+## Exporting trained model to JSON and importing
+
+You can export the model to a json with the _toJSON_ method, and import a model from a json with _fromJSON_ method:
+
+```javascript
+const { NeuralNetwork } = require('@nlpjs/neural');
+const corpus = require('./corpus.json');
+
+let net = new NeuralNetwork();
+net.train(corpus);
+const exported = net.toJSON();
+net = new NeuralNetwork();
+net.fromJSON(exported);
+console.log(net.run({ when: 1, birthday: 1 }));
+```
+
+## Options
+
+There are several options that you can customize:
+- _iterations_: maximum number of iterations (epochs) that the neural network can run. By default this is 20000.
+- _errorThresh_: minimum error threshold, if the loss is lower than this number, then the training ends. By default this is 0.00005.
+- _deltaErrorThresh_: minimum delta error threshold, this is, the difference between the current and the last errors. If the delta error threshold is lower than this number, then the training ends. By default this is 0.000001.
+- _learningRate_: learning rate for the neural network. By default this is 0.6.
+- _momentum_: momentum for the gradient descent optimization. By default this is 0.5.
+- _alpha_: Multiplicator or alpha factor for the ReLu activation function. By default this is 0.07.
+- _log_: If is *false* then no log happens, if is *true* then there is log in console. Also a function can be provided, and will receive two parameters: the status and the elapsed time of the last epoch. By default this is false.
+
+Example of how to provide parameters:
+```javascript
+const { NeuralNetwork } = require('@nlpjs/neural');
+const corpus = require('./corpus.json');
+
+const net = new NeuralNetwork({ learningRate: 0.01, log: true });
+net.train(corpus);
+console.log(net.run({ when: 1, birthday: 1 }));
+// Epoch 2382 loss 0.0013668740975184709 time 0ms
+// { who: 0, developer: 0, birthday: 0.8050273840765896 }
+```
+
+## Contributing
+
+You can read the guide of how to contribute at [Contributing](CONTRIBUTING.md).
+
+## Contributors
+
+[![Contributors](https://contributors-img.firebaseapp.com/image?repo=axa-group/nlp.js)](https://github.com/axa-group/nlp.js/graphs/contributors)
+
+Made with [contributors-img](https://contributors-img.firebaseapp.com).
+
+## Code of Conduct
+
+You can read the Code of Conduct at [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Who is behind it`?`
+
+This project is developed by AXA Group Operations Spain S.A.
+
+If you need to contact us, you can do it at the email [e-mail]
+
+## License
+
+Copyright (c) AXA Group Operations Spain S.A.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

src/neural-network.js

@@ -29,3 +29,2 @@ /*
   errorThresh: 0.00005,
-  fixedError: false,
   deltaErrorThresh: 0.000001,
@@ -32,0 +31,0 @@ learningRate: 0.6,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21297

increased by35.47%

Dependency count

0

decreased by-100%

Number of lines in readme file

160

increased by1233.33%

Worsened metrics

Lines of code

397

decreased by-0.25%

Dependency changes

• - Removed@nlpjs/core@^4.11.0

• - Removed@nlpjs/core@4.26.1(transitive)