markovian-nlp - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

package.json

 {
   "name": "markovian-nlp",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Markov chains & NLP",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

 # markovian-nlp
-[![NpmLicense](https://img.shields.io/npm/l/markovian-nlp.svg)](LICENSE)
-[![npm](https://img.shields.io/npm/v/markovian-nlp.svg)](https://www.npmjs.com/package/markovian-nlp)
+[![license][shields license]][markovian-nlp license]
+[![npm current version][shields npm]][npm markovian-nlp]
 
 ## Setup
-### Demo
-* [test with RunKit](https://npm.runkit.com/markovian-nlp)
-
 ### Installation
-With [`npm`](https://www.npmjs.com/get-npm) installed, run terminal command:
+With [`npm`][npm install] installed, run terminal command:
 ```shell
 npm i markovian-nlp
 ```
-* [npm package](https://www.npmjs.com/package/markovian-nlp)
+* [npm package][npm markovian-nlp]
 
 ## Usage
 ### Module import
-At the top of each JavaScript file where module will be used, declare an import.
+Declare method import at the top of each JavaScript file it will be used.
 
 #### ES2015
 ```es6
-import markovianNlp from 'markovian';
+import ngramsDistribution from 'markovian-nlp';
 ```
@@ -27,3 +24,102 @@
 ```javascript
-const markovianNlp = require('markovian-nlp');
+const ngramsDistribution = require('markovian-nlp');
 ```
+
+## Glossary
+Learn more about [computational linguistics][wikipedia computational linguistics] and [natural language processing (NLP)][wikipedia natural language processing] on Wikipedia.
+
+The following terms are used in the API documentation:
+
+term | description
+---- | ---
+[bigram][wikipedia bigram] | 2-gram sequence
+endgram | final gram in a sequence
+[_n_-gram][wikipedia n-gram] | contiguous gram (word) sequence
+startgram | first gram in a sequence
+unigram | 1-gram sequence
+
+## API
+### ngramsDistribution(document)
+_View the [__n-grams distribution__][wikipedia n-gram] of text._
+
+Potential applications: [Markov models][wikipedia markov model]
+
+#### Example
+```es6
+ngramsDistribution('birds have featured in culture and art since prehistoric times');
+```
+* [test with RunKit][runkit markovian-nlp]
+
+##### Output
+```es6
+{
+  and: Object { _end: 0, _start: 0, art: 1 },
+  art: Object { _end: 0, _start: 0, since: 1 },
+  birds: Object { _end: 0, _start: 1, have: 1 },
+  culture: Object { _end: 0, _start: 0, and: 1 },
+  featured: Object { _end: 0, _start: 0, in: 1 },
+  have: Object { _end: 0, _start: 0, featured: 1 },
+  in: Object { _end: 0, _start: 0, culture: 1 },
+  prehistoric: Object { _end: 0, _start: 0, times: 1 },
+  since: Object { _end: 0, _start: 0, prehistoric: 1 },
+  times: Object { _end: 1, _start: 0 },
+}
+```
+Each number represents the sum of occurrences.
+
+startgram | endgram | bigrams
+--------- | ------- | -------
+"birds" | "times" | _all remaining keys_ ("have **featured**", "featured **in**", etc.)
+
+#### Input
+user-defined parameter | type | implements | intermediate transformations
+---------------------- | ---- | ---------- | ----------------------------
+`document` | [String][mdn string] | [compromise][npm compromise] (`document`) | [normalization][compromise normalization], [rule-based text parsing][wikipedia rule-based system]
+
+#### Return value
+type | description
+---- | -----------
+[Object][mdn object] | distributions of unigrams to startgrams, endgrams, and following bigrams
+
+##### Signature
+```es6
+// pseudocode (does not run)
+ngramsDistribution(document) => ({
+  ...unigrams: {
+    ...{ ...bigram: bigramsDistribution },
+    _end: endgramsDistribution,
+    _start: startgramsDistribution,
+  },
+});
+```
+
+[compromise normalization]: https://github.com/spencermountain/compromise/wiki/How-it-Works#3-normalization
+    (compromise wiki: How normalization works)
+[markovian-nlp license]: LICENSE
+    (markovian-nlp license)
+[npm compromise]: https://www.npmjs.com/package/compromise
+    (npm: compromise)
+[npm install]: https://www.npmjs.com/get-npm
+    (npm: install npm with Node.js)
+[npm markovian-nlp]: https://www.npmjs.com/package/markovian-nlp
+    (npm: markovian-nlp)
+[mdn object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
+    (MDN JavaScript reference: Object)
+[mdn string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
+    (MDN JavaScript reference: String)
+[runkit markovian-nlp]: https://npm.runkit.com/markovian-nlp
+    (RunKit+npm: test markovian-nlp)
+[shields license]: https://img.shields.io/npm/l/markovian-nlp.svg
+[shields npm]: https://img.shields.io/npm/v/markovian-nlp.svg
+[wikipedia bigram]: https://en.wikipedia.org/wiki/Bigram
+    (Wikipedia: Bigram)
+[wikipedia computational linguistics]: https://en.wikipedia.org/wiki/Computational_linguistics
+    (Wikipedia: Computational linguistics)
+[wikipedia markov model]: https://en.wikipedia.org/wiki/Markov_model
+    (Wikipedia: Markov model)
+[wikipedia n-gram]: https://en.wikipedia.org/wiki/N-gram
+    (Wikipedia: n-gram)
+[wikipedia natural language processing]: https://en.wikipedia.org/wiki/Natural_language_processing
+    (Wikipedia: Natural language processing)
+[wikipedia rule-based system]: https://en.wikipedia.org/wiki/Rule-based_system
+    (Wikipedia: Rule-based system)

No alert changes

Improved metrics

Total package byte prevSize

48206

8.82%

Number of lines in readme file

125

331.03%

No dependency changes