Skip to content

Latest commit

 

History

History
113 lines (93 loc) · 3.79 KB

neural.md

File metadata and controls

113 lines (93 loc) · 3.79 KB
Raw

NeuralNetwork

Introduction

NeuralNetwork is the class for an NLU Neural Network, able to train a classifier and then classify into intents.

Installing

NeuralNetwork is a class of the package @nlpjs/neural, that you can install via NPM:

  npm install @nlpjs/neural

Corpus Format

To train 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 for the intent:

[
  {
    "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, "born": 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 of this example. This will train the corpus and run the input equivalent to the sentence "when birthday". The result is a list of all intents with the score for each intent.

const { NeuralNetwork } = require('@nlpjs/neural');
const corpus = require('./corpus.json');

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:

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 error and the last error. 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 details are logged in console. You can also provide a function, and it 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:

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 }