npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nbayes

v4.0.0

Published

A Naive Bayes Classifier.

Downloads

53

Readme

nbayes

nbayes is a lightweight Naive Bayes Classifier written in vanilla JavaScript. It classifies a document (arbitrary piece of text) among the classes (arbitrarily named categories) it has been trained with before. This is all based on simple mathematics. As an example, you could use nbayes to answer the following questions.

npm version build status dependency status dev dependency status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

  • Is an email spam, or not spam ?
  • Is a news article about technology, politics, or sports ?
  • Does a piece of text express positive emotions, or negative emotions?
const nbayes = require('nbayes')

let classifier = nbayes()
classifier.learn('happy',   nbayes.stringToDoc('amazing, awesome movie!! Yeah!! Oh boy.'))
classifier.learn('happy',   nbayes.stringToDoc('Sweet, this is incredibly amazing, perfect, great!!'))
classifier.learn('angry',   nbayes.stringToDoc('terrible, shitty thing. Damn. This Sucks!!'))
classifier.learn('neutral', nbayes.stringToDoc('I dont really know what to make of this.'))

classifier.classify(nbayes.stringToDoc('awesome, cool, amazing!! Yay.'))
// -> 'happy'

nbayes offers a simple and straightforward API, keeping it below 3kb (minified). It is a rewrite of ttezel/bayes and thoroughly tested.

Installing

npm install nbayes

API

nbayes.createDoc()

Creates a representation of a document, which can be used to track words and their frequencies.

Example

let d = nbayes.createDoc()
d.set('foo', 2)
d.add('bar')
d.increase('bar', 2)

d.has('FOO') // -> false
d.get('foo') // -> 2
d.get('bar') // -> 3
d.sum() // -> 5
d.words() // -> ['foo', 'bar']

Methods

  • has(word): If word has been added before.
  • get(word): Returns the count of word.
  • set(word, count): Sets the count of word.
  • add(word): Shorthand for increase(word, 1).
  • increase(word, d = 1): Adds d to the count of word.
  • sum: Returns the sum of all word counts.
  • words: Returns the distinct words.

nbayes.stringToDoc()

Returns a document from the string. Special characters will be ignored. Everything will be lowercase.

Note: It is probably a better idea to use a proper tokenizer/stemmer and to remove stopwords to support non-Latin languages and to get more accurate results.

nbayes.stringToDoc('awesome, amazing!! Yay.').words()
// -> ['awesome', 'amazing', 'yay']

nbayes()

Creates a classifier, which can learn and then classify documents into classes.

Example

let c = nbayes()
c.learn('happy',   nbayes.stringToDoc('amazing, awesome movie!! Yeah!! Oh boy.'))
c.learn('happy',   nbayes.stringToDoc('Sweet, this is incredibly amazing, perfect, great!!'))
c.learn('angry',   nbayes.stringToDoc('terrible, shitty thing. Damn. This Sucks!!'))
c.learn('neutral', nbayes.stringToDoc('I dont really know what to make of this.'))

c.classify(nbayes.stringToDoc('awesome, cool, amazing!! Yay.'))
// -> 'happy'
c.probabilities(nbayes.stringToDoc('awesome, cool, amazing!! Yay.'))
// -> { happy: 0.000001…,
//      angry: 2.384…e-7,
//      neutral: 1.665…e-7 }

Methods

  • learn(class, doc): Tags words of doc as being of class.
  • probabilities(doc): For each stored class, returns the probability of doc, given the class.
  • classify(doc): For doc, returns the class with the highest probability.
  • prior(class): Computes the probability of class out of all classes.
  • likelihood(class, doc): Computes the probability of doc, given class.

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.