|
1 | 1 | # wink-eng-lite-model |
2 | | -English lite model for wink-nlp |
| 2 | +English lite language model for wink-nlp. |
| 3 | + |
| 4 | +[<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://wink.org.in/) |
| 5 | +This is a pre-trained English language model for the winkjs NLP package — [wink-nlp](https://winkjs.org/wink-nlp/). The lite model package has a size of under 800KB, which expands to about 2.4MB after installation. It contains models for the following NLP tasks: |
| 6 | + |
| 7 | +1. Tokenization |
| 8 | +2. Token's Feature Extraction |
| 9 | +3. Sentence Boundary Detection |
| 10 | +4. Negation Handling |
| 11 | +5. POS tagging |
| 12 | +6. Lemmatization (upcoming) |
| 13 | +7. Named Entity Recognition |
| 14 | +8. Sentiment Analysis |
| 15 | +9. Custom Entities Definition |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +### Getting Started |
| 20 | + |
| 21 | +#### Installation |
| 22 | +The model must be installed along with the [wink-nlp](https://winkjs.org/wink-nlp/): |
| 23 | + |
| 24 | +```sh |
| 25 | +# Install wink-nlp |
| 26 | +npm install wink-nlp --save |
| 27 | +# Install wink-eng-lite-model |
| 28 | +npm install https://github.com/winkjs/wink-eng-lite-model/releases/download/0.1.0/wink-eng-lite-model-0.1.0.tgz --save |
| 29 | +``` |
| 30 | + |
| 31 | +#### Example |
| 32 | +We start by requiring the **wink-nlp** package and the **wink-eng-lite-model**. Then we instantiate wink-nlp using the language model: |
| 33 | + |
| 34 | +```javascript |
| 35 | +// Load "wink-nlp" package. |
| 36 | +const winkNLP = require('wink-nlp'); |
| 37 | +// Load english language model — light version. |
| 38 | +const model = require('wink-eng-lite-model'); |
| 39 | +// Instantiate wink-nlp. |
| 40 | +const nlp = winkNLP(model); |
| 41 | + |
| 42 | +// Code for Hello World! |
| 43 | +var text = 'Hello World!'; |
| 44 | +var doc = nlp.readDoc(text); |
| 45 | +console.log(doc.out()); |
| 46 | +// -> Hello World! |
| 47 | +``` |
| 48 | + |
| 49 | + |
| 50 | +#### Documentation |
| 51 | +Check out the wink-nlp's [concepts](https://winkjs.org/wink-nlp/getting-started.html) and [API reference](https://winkjs.org/wink-nlp/read-doc.html) to learn more about the package. |
| 52 | + |
| 53 | +### Need Help? |
| 54 | +If you spot a bug and the same has not yet been reported, raise a new [issue](https://github.com/winkjs/wink-eng-lite-model/issues). |
| 55 | + |
| 56 | +### About wink |
| 57 | +[Wink](http://winkjs.org/) is a family of open source packages for **Natural Language Processing**, **Machine Learning** and **Statistical Analysis** 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. |
| 58 | + |
| 59 | + |
| 60 | +### Copyright & License |
| 61 | +The **wink-eng-lite-model** is copyright 2020 of [GRAYPE Systems Private Limited](http://graype.in/). |
| 62 | + |
| 63 | +It is licensed under the terms of the MIT License. |
| 64 | + |
0 commit comments