A Kohonen Network api for Node
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
examples/colors
test
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

A Kohonen Network API for Node.js

The Self-Organizing Map (commonly also known as Kohonen network) defines an ordered mapping, a kind of projection from a set of given data items onto a regular, usually two-dimensional grid.

npm status

Build Status

Installation

$ npm install node-som

Color Clustering Example

This example shows how the SOM can adaptively cluster a random RGB input space based on the network's training state.

$ npm install node-som
$ cd node_modules/node-som/
$ node examples/colors/colors-cluster.js
$ open examples/colors/color.html

Usage

// Inject the module
var som = require('node-som');

// Create the instance
var somInstance = new som({
	inputLength: 2,
	maxClusters: 5,
	loggingEnabled: true,
	scale: {
		min : 0,
		max : 1000
	}
});

/**
 * Train (all automatic). Optionally, you can include custom input vectors, but 
 * it is recommended that developers allow the automated training (based on the 
 * `scale` configuration) since this results in better networks
 */
 somInstance.train();

/**
 * Create input array. 
 * All items features should be normalized to domain [0,1]
 */
var sample = [0.24, 0.34];

// Call classify to receive your classification group/neuron
var group = somInstance.classify(sample);

// For the sake of intelligence, you can use the somInstance.statistics object to track known neuron usage

Options

###loggingEnabled (bool) Enables/Disables logging on the console

###maxClusters (Integer) Max number of Classification groups to use. This is an upper-bound and an optimized network usually contains less than this number.

###created (Date) When the network was initially created

###classificationCount (Integer) Represents the number of classifications run through the network. Used as a metric of maturity.

###inputLength (Integer) Component length of input vectors

###inputPatterns (Integer) Represents the number of random samples to self-train on. Higher numbers cost more, but can result in more granular groups

###scale (Complex) Tells the SOM how to train to insure high accuracy on the target domain. ex. {min: -1000, max: 1000}

API

###train Accepts an array of unscaled input vectors of ordinal length inputLength. The implementation scales itself, based on the scale constructor configuration.

If no training vectors are provided, Recommended, a random set is generated and trained based on the __inputPatterns__ configuration.

Note: This results in the most optimized network.

###classify Given a single unscaled input vector, will return the classification/neuron that best describes the input based on the network state

###extract Given a classication/neuron, will return component statistics for unscaled input vector extraction. Statistics are in the form of component ranges.

Its up to the developer to use this information to infer about their own domain, since the network doesn't hold on to the entire input domain upon training/classification (for momento purposes).

###serialize Serialize the network for future use.

Reloading the network can be done by passing the serialized json into the constructor on instantiation.

###scaleInput Scales a vector of inputLength based on the SOM's scale boundaries.

Note: Scaling is done internally. No need to do this unless extending the network implementation.

###descaleInput Descales a scalled vector of inputLength based on the SOM's scale boundaries.

Note: Descaling is done internally. No need to do this unless extending the network implementation.