wink-nlp - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

.nyc_output/processinfo/index.json

@@ -1,1 +0,1 @@
-{"processes":{"7084daf1-1a02-41eb-8176-d505c3396cc2":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["7084daf1-1a02-41eb-8176-d505c3396cc2"]},"externalIds":{}}
+{"processes":{"b1842c67-ef05-4fda-9f55-0cee4c379d23":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bow-cosine-similarity.js":["b1842c67-ef05-4fda-9f55-0cee4c379d23"]},"externalIds":{}}

CHANGELOG.md

@@ -0,1 +1,9 @@
+# [Introducing cosine similarity & readability stats helper](https://github.com/winkjs/wink-nlp/releases/tag/1.4.0)
+## Version 1.4.0 June 15, 2021
+
+### ✨ Features
+- Cosine similarity is available on Bag of Words. 🛍🔡🎉
+- You can now use `its.readabilityStats` helper to obtain document's readability statistics, if it is supported by language model. 📚📊🤓
+
+
 # [Adding long pending lemmatizer support](https://github.com/winkjs/wink-nlp/releases/tag/1.3.0)
@@ -2,0 +10,0 @@ ## Version 1.3.0 May 22, 2021

models/language-models.json

 [
-  { "name": "wink-eng-lite-model", "version": "1.2.0" }
+  { "name": "wink-eng-lite-model", "version": "1.3.0" }
 ]

package.json

 {
   "name": "wink-nlp",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Developer friendly NLP ✨",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # winkNLP
 
-### [![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) [![Follow on Twitter](https://img.shields.io/twitter/follow/winkjs_org?style=social)](https://twitter.com/winkjs_org)
+### [![Build Status](https://travis-ci.com/winkjs/wink-nlp.svg?branch=master)](https://travis-ci.com/github/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) [![Follow on Twitter](https://img.shields.io/twitter/follow/winkjs_org?style=social)](https://twitter.com/winkjs_org)
 
@@ -24,3 +24,3 @@ ## Developer friendly NLP ✨
 
-5. Extensive text pre-processing features
+5. Extensive text processing features such as bag-of-words, frequency table, stop word removal, readability statistics computation and many more.
 
@@ -31,11 +31,13 @@ 6. Pre-trained models with sizes starting from <3MB onwards
 
-8. Word vector integration
+8. Cosine similarity
 
-9. Comprehensive NLP pipeline covering tokenization, sentence boundary detection, negation handling, sentiment analysis, part-of-speech (pos) tagging, lemmatization, named entity extraction, custom entities detection and pattern matching
+9. Word vector integration
 
-10. No external dependencies.
+10. Comprehensive NLP pipeline covering tokenization, sentence boundary detection, negation handling, sentiment analysis, part-of-speech (pos) tagging, lemmatization, named entity extraction, custom entities detection and pattern matching
 
-11. Runs on web browsers
+11. No external dependencies.
 
+12. Runs on web browsers
 
+
 ## Installation
@@ -42,0 +44,0 @@

src/allowed.js

@@ -100,5 +100,14 @@ //     wink-nlp
 
-allowed.its4document = allowed.its4sentence;
+allowed.its4document = new Set( [
+  its.value,
+  its.normal,
+  its.span,
+  its.markedUpText,
+  its.negationFlag,
+  its.sentiment,
+  its.stem,
+  its.readabilityStats
+] );
 
 
 module.exports = allowed;

src/api/itm-document-out.js

@@ -66,2 +66,6 @@ //     wink-nlp
 
+  if ( itsfn === its.readabilityStats ) {
+    return itsfn( rdd, addons );
+  }
+
   // Setup the correct `as.fn` becuase the current markedup text would have
@@ -68,0 +72,0 @@ // returned the `value`. Refer to `its.markedUpText`.

src/its.js

@@ -161,2 +161,6 @@ //     wink-nlp
 
+its.readabilityStats = function ( rdd, addons ) {
+  return addons.readabilityStats( rdd, its );
+}; // readabilityStats()
+
 /* ------ utilities ------ */
@@ -163,0 +167,0 @@

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

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

508911

increased by1.71%

Number of package files

55

increased by1.85%

Lines of code

5323

increased by2.11%

Number of lines in readme file

146

increased by1.39%

No dependency changes