Skip to content

Commit 18ad872

Browse files
docs(README): add link to recipes
1 parent 7c6dc09 commit 18ad872

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Any required model can be installed by specifying its name as the last parameter
5656
node -e "require( 'wink-nlp/models/install' )" wink-eng-lite-model
5757
```
5858

59-
#### How to install for Web Browser
59+
### How to install for Web Browser
6060
If you’re using winkNLP in the browser use the [wink-eng-lite-web-model](https://www.npmjs.com/package/wink-eng-lite-web-model) instead. Learn about its installation and usage in our [guide to using winkNLP in the browser](https://winkjs.org/wink-nlp/how-to-run-wink-nlp-in-browser.html).
6161

6262
## Getting Started
63-
The "Hello World!" in winkNLP is given below. As the next step, we recommend a dive into [winkNLP's concepts](https://winkjs.org/wink-nlp/getting-started.html).
63+
The "Hello World!" in winkNLP is given below:
6464

6565
```javascript
6666
// Load wink-nlp package & helpers.
@@ -93,8 +93,8 @@ console.log( doc.tokens().out() );
9393
console.log( doc.tokens().out( its.type, as.freqTable ) );
9494
// -> [ [ 'word', 5 ], [ 'punctuation', 2 ], [ 'emoji', 1 ] ]
9595
```
96-
97-
Try a sample code at [RunKit](https://npm.runkit.com/wink-nlp) or head to [showcases](https://winkjs.org/showcase.html) to learn from live examples:
96+
<sub>[Try the above code on RunKit](https://npm.runkit.com/wink-nlp)</sub>
97+
<br/>Dive into [winkNLP's concepts](https://winkjs.org/wink-nlp/getting-started.html) or head to **[winkNLP recipes](https://observablehq.com/collection/@winkjs/winknlp-recipes)** for common NLP tasks or just explore live [showcases](https://winkjs.org/showcase.html) to learn:
9898

9999
#### [Wikipedia Timeline](https://winkjs.org/showcase-timeline/)
100100
Reads any wikipedia article and generates a visual timeline of all its events.
@@ -105,6 +105,8 @@ Performs tokenization, sentence boundary detection, pos tagging, named entity de
105105
#### [Hashtag Sentiment](https://winkjs.org/showcase-hashtag/) 🎭
106106
Analyzes sentiments of recent tweets containing the given hashtag.
107107

108+
109+
108110
## Speed & Accuracy
109111
The [winkNLP](https://winkjs.org/wink-nlp/) processes raw text at **~525,000 tokens per second** with its default language model — [wink-eng-lite-model](https://github.com/winkjs/wink-eng-lite-model), when [benchmarked](https://github.com/bestiejs/benchmark.js) using "Ch 13 of Ulysses by James Joyce" on a 2.2 GHz Intel Core i7 machine with 16GB RAM. The processing included the entire NLP pipeline — tokenization, sentence boundary detection, negation handling, sentiment analysis, part-of-speech tagging, and named entity extraction. This speed is way ahead of the prevailing speed benchmarks.
110112

0 commit comments

Comments
 (0)