updated README. Added bench text file
This commit is contained in:
moos
parent
3544796afe
commit
40411b7f3a
198
README.md
198
README.md
|
|
@ -1,50 +1,202 @@
|
|||
wordpos
|
||||
=======
|
||||
|
||||
wordpos is a set of part-of-speech utilities using [natrual's](http://github.com/NaturalNode/natural) WordNet module.
|
||||
wordpos is a set of part-of-speech utilities for Node.js using [natural's](http://github.com/NaturalNode/natural) WordNet module.
|
||||
|
||||
There is no lexigraphical intelligence here. Only dictionary lookup.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Get the script and use it. (npm module may be coming.)
|
||||
Get the script `wordpos.js` and use it. (npm module may be coming.)
|
||||
|
||||
Note: wordpos-bench requires customized bench module (forthcoming).
|
||||
You may also want to manually download WordNet files from [here](http://wordnet.princeton.edu/wordnet/download/current-version/).
|
||||
Unpack into folder (say `dict`, see below). [natrual](http://github.com/NaturalNode/natural) will auto-download WordNet files --
|
||||
but I've found this to be unreliable as some of the files get truncated and the core program hangs.
|
||||
|
||||
Note: `wordpos-bench` requires a customized [uubench](https://github.com/moos/uubench) module (forthcoming).
|
||||
|
||||
Usage
|
||||
----------
|
||||
-------
|
||||
|
||||
```js
|
||||
var WordPOS = require('./wordpos'),
|
||||
wordpos = new WordPOS('dict');
|
||||
|
||||
wordpos.getAdjectives('The angry bear chased the frightened little squirrel.', function(results){
|
||||
console.log(results);
|
||||
wordpos.getAdjectives('The angry bear chased the frightened little squirrel.', function(result){
|
||||
console.log(result);
|
||||
});
|
||||
// [ 'little', 'angry', 'frightened' ]
|
||||
|
||||
|
||||
See wordpos_spec.js for full usage.
|
||||
wordpos.isAdjective('awesome', function(result){
|
||||
console.log(result);
|
||||
});
|
||||
// true
|
||||
```
|
||||
|
||||
See `wordpos_spec.js` for full usage.
|
||||
|
||||
API
|
||||
-------
|
||||
|
||||
Please note: all API are async since the underlying WordNet library is async.
|
||||
|
||||
WordPOS is a subclass of natural's [WordNet](https://github.com/NaturalNode/natural#wordnet) class
|
||||
and inherits call it's methods.
|
||||
|
||||
|
||||
### getX()
|
||||
|
||||
Get POS from text.
|
||||
|
||||
```js
|
||||
wordpos.getPOS(str, callback) -- callback receives a result object:
|
||||
{
|
||||
nouns:[], Array of str words that are nouns
|
||||
verbs:[], Array of str words that are verbs
|
||||
adjectives:[], Array of str words that are adjectives
|
||||
adverbs:[], Array of str words that are adverbs
|
||||
rest:[] Array of str words that are not in dict
|
||||
}
|
||||
|
||||
Note: a word may appear in multiple POS (eg, 'great' is both a noun and an adjective)
|
||||
|
||||
wordpos.getNouns(str, callback) -- callback receives an array of nouns in str
|
||||
|
||||
wordpos.getVerbs(str, callback) -- callback receives an array of verbs in str
|
||||
|
||||
wordpos.getAdjectives(str, callback) -- callback receives an array of adjectives in str
|
||||
|
||||
wordpos.getAdverbs(str, callback) -- callback receives an array of adverbs in str
|
||||
```
|
||||
|
||||
NB: If you're only interested in a certain POS (say, adjectives), using the particular getX() is faster
|
||||
than getPOS() which looks up the word in all index files.
|
||||
|
||||
NB: [stopwords] (https://github.com/NaturalNode/natural/blob/master/lib/natural/util/stopwords.js)
|
||||
are stripped out from str before lookup.
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
wordpos.getNouns('The angry bear chased the frightened little squirrel.', console.log)
|
||||
// [ 'bear', 'squirrel', 'little', 'chased' ]
|
||||
```
|
||||
|
||||
getNouns() returns all words within given (context-free) string of words that can be considered nouns (via
|
||||
WordNet lookup). This has no relation to correct grammer of given sentence, where here only 'bear' and 'squirrel'
|
||||
would be considered nouns. (see http://nltk.googlecode.com/svn/trunk/doc/book/ch08.html#ex-recnominals)
|
||||
|
||||
|
||||
### isX()
|
||||
|
||||
Determine if a word is a particular POS.
|
||||
|
||||
```js
|
||||
wordpos.isNoun(word, callback) -- callback receives result (true/false) if word is a noun.
|
||||
|
||||
wordpos.isVerb(word, callback) -- callback receives result (true/false) if word is a verb.
|
||||
|
||||
wordpos.isAdjective(word, callback) -- callback receives result (true/false) if word is an adjective.
|
||||
|
||||
wordpos.isAdverb(word, callback) -- callback receives result (true/false) if word is an adverb.
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```js
|
||||
wordpos.isVerb('fish', console.log);
|
||||
// true
|
||||
|
||||
wordpos.isNoun('fish', console.log);
|
||||
// true
|
||||
|
||||
wordpos.isAdjective('fishy', console.log);
|
||||
// true
|
||||
|
||||
wordpos.isAdverb('fishly', console.log);
|
||||
// false
|
||||
```
|
||||
|
||||
### lookupX()
|
||||
|
||||
These calls are similar to natural's [lookup()](https://github.com/NaturalNode/natural#wordnet) call, except they can be faster if you
|
||||
already know the POS of the word.
|
||||
|
||||
```js
|
||||
wordpos.lookupNoun(word, callback) -- callback receives array of lookup objects for a noun
|
||||
|
||||
wordpos.lookupVerb(word, callback) -- callback receives array of lookup objects for a verb
|
||||
|
||||
wordpos.lookupAdjective(word, callback) -- callback receives array of lookup objects for an adjective
|
||||
|
||||
wordpos.lookupAdverb(word, callback) -- callback receives array of lookup objects for an adverb
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
wordpos.lookupAdjective('awesome', console.log);
|
||||
// output:
|
||||
[ { synsetOffset: 1282510,
|
||||
lexFilenum: 0,
|
||||
pos: 's',
|
||||
wCnt: 5,
|
||||
lemma: 'amazing',
|
||||
synonyms: [ 'amazing', 'awe-inspiring', 'awesome', 'awful', 'awing' ],
|
||||
lexId: '0',
|
||||
ptrs: [],
|
||||
gloss: 'inspiring awe or admiration or wonder; "New York is an amazing city"; "the Grand Canyon is an awe-inspiring
|
||||
sight"; "the awesome complexity of the universe"; "this sea, whose gently awful stirrings seem to speak of some hidden s
|
||||
oul beneath"- Melville; "Westminster Hall\'s awing majesty, so vast, so high, so silent" ' } ]
|
||||
```
|
||||
In this case only one lookup was found. But there could be several.
|
||||
|
||||
|
||||
Or use WordNet's inherited method directly:
|
||||
|
||||
wordpos.lookup('great', console.log);
|
||||
// ...
|
||||
|
||||
Benchmark
|
||||
----------
|
||||
|
||||
Generally slow as it requires loading and searching large WordNet index files.
|
||||
|
||||
Single word lookup:
|
||||
|
||||
getPOS : 22 ops/s { iterations: 10, elapsed: 451 }
|
||||
getNouns : 66 ops/s { iterations: 10, elapsed: 152 }
|
||||
getVerbs : 66 ops/s { iterations: 10, elapsed: 152 }
|
||||
getAdjectives : 67 ops/s { iterations: 10, elapsed: 150 }
|
||||
getAdverbs : 83 ops/s { iterations: 10, elapsed: 120 }
|
||||
|
||||
On a win7/64-bit/dual-core/3GHz. getPOS() is slowest as it searches through all four index files.
|
||||
|
||||
There is probably room for optimization in the underlying library.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2012, mooster@42at.com
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
|
|||
Loading…
Reference in New Issue