docs(*): update nlp utils description

winkjs · Oct 14, 2017 · ffa7d18 · ffa7d18
1 parent 7c83653
commit ffa7d18
Show file tree

Hide file tree

Showing 45 changed files with 89 additions and 89 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 
 # wink-nlp-utils
 
-> Easily tokenize, stem, phonetize, remove stop words, manage elisions, create ngrams, bag of words and more
+> NLP Functions for amplifying negations, managing elisions, creating ngrams, stems, phonetic codes to tokens and more.
 
 ### [![Build Status](https://api.travis-ci.org/winkjs/wink-nlp-utils.svg?branch=master)](https://travis-ci.org/winkjs/wink-nlp-utils) [![Coverage Status](https://coveralls.io/repos/github/winkjs/wink-nlp-utils/badge.svg?branch=master)](https://coveralls.io/github/winkjs/wink-nlp-utils?branch=master) [![Inline docs](http://inch-ci.org/github/winkjs/wink-nlp-utils.svg?branch=master)](http://inch-ci.org/github/winkjs/wink-nlp-utils) [![dependencies Status](https://david-dm.org/winkjs/wink-nlp-utils/status.svg)](https://david-dm.org/winkjs/wink-nlp-utils) [![devDependencies Status](https://david-dm.org/winkjs/wink-nlp-utils/dev-status.svg)](https://david-dm.org/winkjs/wink-nlp-utils?type=dev)
 
 [<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://wink.org.in/)
 
 Prepare raw text for Natural Language Processing (NLP) using **`wink-nlp-utils`**.It is a part of _[wink](http://wink.org.in/)_ — a growing family of high quality packages for Statistical Analysis, Natural Language Processing and Machine Learning in NodeJS.
 
-It offers a set of **[APIs](#apis)** to work on **[strings](#string)** such as names, sentences, paragraphs and **[tokens](#tokens)** represented as an array of strings/words. They perform the required pre-processing for many simple ML tasks such as [semantic search](https://www.npmjs.com/package/wink-bm25-text-search), and [classification](https://www.npmjs.com/package/wink-naive-bayes-text-classifier).
+It offers a set of **[APIs](wink.org.in/wink-nlp-utils/)** to work on **[strings](http://wink.org.in/wink-nlp-utils/#string)** such as names, sentences, paragraphs and **[tokens](http://wink.org.in/wink-nlp-utils/#tokens)** represented as an array of strings/words. They perform the required pre-processing for many simple ML tasks such as [semantic search](https://www.npmjs.com/package/wink-bm25-text-search), and [classification](https://www.npmjs.com/package/wink-naive-bayes-text-classifier).
 
 
 ## Installation

diff --git a/docs/index.html b/docs/index.html
@@ -2333,7 +2333,7 @@ <h3 class='fl m0' id='stringtokenize'>
   </div>
 
 
-  <p>The function uses the following set of rules to tokenize: </p>
+  <p>The function uses the following set of rules to tokenize:</p>
 <ol>
 <li>Single quotes are processed first as they may be part of elisions; and
 <code>...</code> are converted to ellipses.</li>

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "wink-nlp-utils",
   "version": "1.6.0",
-  "description": "Natural Language Processing Utilities that let you tokenize, stem, phonetize, create ngrams, bag of words and more.",
+  "description": "NLP Functions for amplifying negations, managing elisions, creating ngrams, stems, phonetic codes to tokens and more.",
   "keywords": [
     "Tokenize",
     "Stem",

diff --git a/src/helper-return-indexer.js b/src/helper-return-indexer.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/helper-return-quoted-text-extractor.js b/src/helper-return-quoted-text-extractor.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/helper-return-words-filter.js b/src/helper-return-words-filter.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/name_cleaner_regexes.js b/src/name_cleaner_regexes.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     Easily tokenize, stem, phonetize, remove stop words,
-//     manage elisions, create ngrams, bag of words and more
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/phonetize_regexes.js b/src/phonetize_regexes.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     Easily tokenize, stem, phonetize, remove stop words,
-//     manage elisions, create ngrams, bag of words and more
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-amplify-not-elision.js b/src/string-amplify-not-elision.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-bong.js b/src/string-bong.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     bongs, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-compose-corpus.js b/src/string-compose-corpus.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-extract-persons-name.js b/src/string-extract-persons-name.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-extract-run-of-capital-words.js b/src/string-extract-run-of-capital-words.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-lower-case.js b/src/string-lower-case.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-marker.js b/src/string-marker.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-ngram.js b/src/string-ngram.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-phonetize.js b/src/string-phonetize.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-remove-elisions.js b/src/string-remove-elisions.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-remove-extra-spaces.js b/src/string-remove-extra-spaces.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-remove-html-tags.js b/src/string-remove-html-tags.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-remove-punctuations.js b/src/string-remove-punctuations.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-remove-spl-chars.js b/src/string-remove-spl-chars.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-retain-alpha-nums.js b/src/string-retain-alpha-nums.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-sentences.js b/src/string-sentences.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-soc.js b/src/string-soc.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-song.js b/src/string-song.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     songs, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-soundex.js b/src/string-soundex.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-split-elisions.js b/src/string-split-elisions.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-stem.js b/src/string-stem.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-tokenize.js b/src/string-tokenize.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //
@@ -31,7 +31,7 @@ var rgx = require( './util_regexes.js' );
 // ### tokenize
 /**
  *
- * The function uses the following set of rules to tokenize: 
+ * The function uses the following set of rules to tokenize:
  *
  * 1. Single quotes are processed first as they may be part of elisions; and
  * `...` are converted to ellipses.

diff --git a/src/string-tokenize0.js b/src/string-tokenize0.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-trim.js b/src/string-trim.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/string-upper-case.js b/src/string-upper-case.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/tokens-append-bigrams.js b/src/tokens-append-bigrams.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, appendBigramsming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE SyappendBigramss Private Limited
 //

diff --git a/src/tokens-bigrams.js b/src/tokens-bigrams.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, bigramsming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Sybigramss Private Limited
 //

diff --git a/src/tokens-bow.js b/src/tokens-bow.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     bows, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/tokens-phonetize.js b/src/tokens-phonetize.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, phonetizeming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Syphonetizes Private Limited
 //

diff --git a/src/tokens-propagate-negations.js b/src/tokens-propagate-negations.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     propagateNegationss, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/tokens-remove-words.js b/src/tokens-remove-words.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, phonetizeming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Syphonetizes Private Limited
 //

diff --git a/src/tokens-soundex.js b/src/tokens-soundex.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, phonetizeming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Syphonetizes Private Limited
 //

diff --git a/src/tokens-sow.js b/src/tokens-sow.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     bows, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //

diff --git a/src/tokens-stem.js b/src/tokens-stem.js
@@ -1,6 +1,6 @@
 //     wink-nlp-utils
-//     NLP Functions for removing HTML Tags, Managing Elisions,
-//     NGrams, Stemming, Phoneticising to Tokenizating and more.
+//     NLP Functions for amplifying negations, managing elisions,
+//     creating ngrams, stems, phonetic codes to tokens and more.
 //
 //     Copyright (C) 2017  GRAYPE Systems Private Limited
 //