Merge branch 'master' of https://github.com/namsor/Java-Naive-Bayes-LevelDB

Author: namsor

README.md

@@ -1,2 +1,44 @@
 # Java-Naive-Bayes-LevelDB
 A Java Naive Bayes Classifier that works on LevelDB or other key-value store 
+
+
+Example
+------------------
+
+Here is an excerpt from the example (inspired by https://github.com/ptnplanet/Java-Naive-Bayes-Classifier/). The classifier will classify sentences (arrays of features) as sentences with either positive or negative sentiment. 
+
+```java
+
+            String[] cats = {POSITIVE, NEGATIVE};
+            // Create a new bayes classifier with string categories and string features.
+            INaiveBayesClassifier bayes = (USE_LEVELDB ? new NaiveBayesClassifierLevelDBImpl("sentiment", cats, ".", 100) : new NaiveBayesClassifierTransientImpl("sentiment", cats));
+
+// Two examples to learn from.
+            String[] positiveText = "I love sunny days".split("\\s");
+            String[] negativeText = "I hate rain".split("\\s");
+
+// Learn by classifying examples.
+// New categories can be added on the fly, when they are first used.
+// A classification consists of a category and a list of features
+// that resulted in the classification in that category.
+            bayes.learn(POSITIVE, new HashSet(Arrays.asList(positiveText)));
+            bayes.learn(NEGATIVE, new HashSet(Arrays.asList(negativeText)));
+
+// Here are two unknown sentences to classify.
+            String[] unknownText1 = "today is a sunny day".split("\\s");
+            String[] unknownText2 = "there will be rain".split("\\s");
+            StringWriter sw = new StringWriter();
+            //bayes.dumpDb(sw);
+            System.out.println(sw);
+            System.out.println( // will output "positive"
+                    bayes.classify(new HashSet(Arrays.asList(unknownText1)))[0].getCategory());
+            System.out.println( // will output "negative"
+                    bayes.classify(new HashSet(Arrays.asList(unknownText2)))[0].getCategory());
+
+
+```
+
+The GNU GPLv3 License
+------------------
+Copyright (c) 2018 - Elian Carsenat, NamSor SAS
+https://www.gnu.org/licenses/gpl-3.0.en.html