bayesian-network - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
     "name": "bayesian-network",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A simple Bayesian Network classifer based on Baye's rule and the conditional independence assumption.",
@@ -5,0 +5,0 @@ "main": "main.js",

README.md

@@ -1,3 +0,25 @@
-# Bayesian Network for Classification
+# Bayesian Network
 
 A simple Bayesian network based on Baye's rule and the conditional independence assumption.
+
+## Example Usage
+
+```javascript
+const classifier = new BayesianNetwork();
+
+classifier.addDocument("hello you are amazing", "positive");
+classifier.addDocument("today is a beautiful day", "positive");
+classifier.addDocument("its dark out today", "negative");
+classifier.addDocument("today was bad", "negative");
+
+classifier.calculateLogFrequencies();
+
+console.log(classifier.classify('hello you are great'));
+
+/*
+{
+  classification: { label: 'POSITIVE', value: -6.238324625039508 },
+  labels: { POSITIVE: -6.238324625039508, NEGATIVE: -6.238324625039508 }
+}
+*/
+```

No alert changes

Improved metrics

Total package byte prevSize

12003873

Number of lines in readme file

26

increased by550%

No dependency changes