Skip to content

Commit 3ec2de5

Browse files
committed
docs
1 parent 894789a commit 3ec2de5

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ $ composer require web64/laravel-nlp
88
$ php artisan vendor:publish
99
```
1010

11-
Plese follow the instructions here to install the NLP Server and CoreNLP server
11+
Plese follow the instructions here to install the NLP Server and CoreNLP server:
1212
* https://github.com/web64/nlpserver
1313
* https://github.com/web64/php-nlp-client
1414

@@ -38,21 +38,15 @@ $lang = NLP::language("What language is this?");
3838
// Entity Extraction
3939
$entities = NLP::entities( $text, 'en' );
4040

41-
4241
// Sentiment analysis
4342
$sentiment = NLP::sentiment( $text, 'en' );
4443

4544
// Translage text to Portuguese
4645
$translated_text = NLP::translate($text, null, 'pt');
4746
```
4847

49-
## Related projects
50-
This package is based on:
51-
* https://github.com/web64/nlpserver
52-
* https://github.com/web64/php-nlp-client
53-
5448
## NLP Server
55-
This package requires a running instance of the NLP Server (https://github.com/web64/nlpserver).
49+
This package requires a running instance of the NLP Server (https://github.com/web64/nlpserver) for most of the functionality to work.
5650
See the documentation for installation instructions of the NLP Server.
5751

5852
## Included Tools
@@ -96,11 +90,11 @@ dump($article);
9690
*/
9791
```
9892

99-
### Entity Extraction
100-
This function uses the Polyglot library which supports entity extraction for 40 languages.
93+
### Entity Extraction with Polyglot
94+
This function uses the [Polyglot](https://polyglot.readthedocs.io/en/latest/Installation.html) library which supports entity extraction for 40 languages.
10195
Make sure you have downloaded the language models for the languages you are using.
10296

103-
For English and other major European languages use Spacy or CoreNLP for best results.
97+
For English and other major European languages use [Spacy](https://spacy.io/usage/) or [CoreNLP](https://stanfordnlp.github.io/CoreNLP/download.html) for best results.
10498
```php
10599
$text = "Barack Hussein Obama is an American politician who served as the 44th President of the United States from January 20, 2009 to January 20, 2017. Before that, he served in the Illinois State Senate from 1997 until 2004.";
106100

0 commit comments

Comments
 (0)