wink-nlp - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

.jsdoc.json

@@ -10,13 +10,12 @@ {
   "docdash": {
+    "meta": {
+      "title": "wink-nlp - Wink JS"
+    },
     "menu":{
-            "Wink JS":{
-                "href":"http://winkjs.org",
-                "target":"_blank"
-            },
-            "Github":{
-                "href":"https://github.com/winkjs/wink-nlp",
-                "target":"_blank"
-            }
-        }
+      "Github": {
+        "href":"https://github.com/winkjs/wink-nlp",
+        "target":"_blank"
+      }
     }
+  }
 }

package.json

 {
   "name": "wink-nlp",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Natural Language Processing",
   "keywords": [
-    "Natural Language Processing",
     "NLP",
+    "tokenize",
+    "SBD",
+    "sentence boundary detection",
+    "negation handling",
+    "sentiment analysis",
+    "POS Tagging",
+    "NER",
+    "named entity extraction",
+    "word vectors",
+    "visualization",
     "wink"
@@ -12,8 +21,8 @@ ],
   "scripts": {
-    "pretest": "npm run lint && npm run docs",
-    "test": "istanbul cover _mocha ./test/",
-    "coveralls": "istanbul cover _mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
-    "sourcedocs": "docker -i src -o ./sourcedocs --sidebar no",
-    "docs": "jsdoc src/*.js -c .jsdoc.json",
-    "lint": "eslint ./src/*.js ./test/*.js ./runkit/*.js"
+    "pretest": "npm run lint",
+    "test": "nyc --reporter=html --reporter=text mocha ./test/",
+    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "sourcedocs": "docker -i src -o ./sourcedocs --sidebar yes",
+    "lint": "eslint ./src/*.js ./test/*.js ./runkit/*.js",
+    "bench": "node benchmark/run.js"
   },
@@ -31,14 +40,12 @@ "repository": {
   "devDependencies": {
+    "benchmark": "^2.1.4",
     "chai": "^4.2.0",
-    "coveralls": "^3.0.2",
-    "docdash": "^1.0.1",
+    "coveralls": "^3.1.0",
     "docker": "^1.0.0",
-    "eslint": "^5.10.0",
-    "istanbul": "^0.4.5",
-    "jsdoc": "^3.5.5",
-    "mocha": "^5.2.0",
-    "mocha-lcov-reporter": "^1.3.0"
+    "eslint": "^7.0.0",
+    "nyc": "^15.0.1",
+    "jsdoc": "^3.6.4",
+    "mocha": "^7.1.2"
   },
-  "runkitExampleFilename": "./runkit/example.js",
   "dependencies": {}
 }

README.md

@@ -5,25 +5,29 @@ # wink-nlp
 
-### [![Stability](https://img.shields.io/badge/stability-1--experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
+### [![Stability](https://img.shields.io/badge/stability-1--experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index) [![Build Status](https://api.travis-ci.org/winkjs/wink-nlp.svg?branch=master)](https://travis-ci.org/winkjs/wink-nlp) [![Coverage Status](https://coveralls.io/repos/github/winkjs/wink-nlp/badge.svg?branch=master)](https://coveralls.io/github/winkjs/wink-nlp?branch=master) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/winkjs/Lobby)
 
 [<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://winkjs.org/)
 
-We have begun our modest attempt to deliver a mature NLP based on the state-of-the-art. Watch out `wink-nlp` unfold over next several weeks.
+Wink NLP is an advance NLP package with zero external dependecies. It supports a variety of NLP tasks such as tokenization, sentence boundary detection, negation handling, sentiment analysis, part-of-speech tagging, named entity extraction and more with ease.
 
+We deliver developer friendly API along with a balance of performance and accuracy to the entire spectrum of users. In addition, we are working towards building a number of pre-trained models for different languages and domains.
+
+It packs a rich feature set into a small foot print codebase of under 100 kilobytes and model sizes starting under 1 megabyte:
+
+1. Lossless tokenizer
+2. Built-in API to aid text visualization
+3. Pre-trained models with word vectors
+4. Easy information exrtaction from raw text
+5. Extensive text pre-processing features
+6. Simple token to Unique Id mapping
+
 ### Installation
 
-It will be as simple as:
+Use npm install:
 
     npm install wink-nlp --save
 
-It will begin to take shape post version 0.0.1. Till then, consider using our [existing NLP packages](https://winkjs.org/packages) such as:
-1. [Multilingual tokenizer](https://www.npmjs.com/package/wink-tokenizer) that tags each token with its type such as word, number, email, mention, etc.
-2. English [Part-of-speech (POS) tagger](https://www.npmjs.com/package/wink-pos-tagger),
-3. Language agnostic [named entity recognizer](https://www.npmjs.com/package/wink-ner),
-4. Useful [functions for common NLP tasks](https://www.npmjs.com/package/wink-nlp-utils) and [many more](https://winkjs.org/packages).
+You will also need the English lite model, to install that use:
 
+    npm install https://github.com/winkjs/wink-eng-lite-model/releases/download/0.0.0/wink-eng-lite-model-0.0.0.tgz --save
 
-### Have a feature request?
-
-Raise a new [issue](https://github.com/winkjs/wink-nlp/issues)  with `feature` label or consider [contributing](https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md).
-
 ### About wink
@@ -34,4 +38,4 @@ [Wink](http://winkjs.org/) is a family of open source packages for **Statistical Analysis**, **Natural Language Processing** and **Machine Learning** in NodeJS. The code is **thoroughly documented** for easy human comprehension and has a **test coverage of ~100%** for reliability to build production grade solutions.
 
-**wink-nlp** is copyright 2017-18 [GRAYPE Systems Private Limited](http://graype.in/).
+**wink-nlp** is copyright 2017-20 [GRAYPE Systems Private Limited](http://graype.in/).
 
 It is licensed under the terms of the MIT License.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

440936

increased by3089.41%

Dev dependency count

8

decreased by-11.11%

Number of package files

48

increased by500%

Lines of code

4717

increased by22361.9%

Number of lines in readme file

40

increased by11.11%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes