watzon
/
wordpos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated README.

This commit is contained in:
moos 2012-05-03 01:40:25 -07:00
parent 40411b7f3a
commit 6ef8c8ce5b
1 changed files with 83 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,21 +1,10 @@
wordpos
=======
wordpos is a set of part-of-speech utilities for Node.js using [natural'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 `wordpos.js` and use it. (npm module may be coming.)
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
-------
@ -36,13 +25,23 @@ Usage
See `wordpos_spec.js` for full usage.
Installation
------------
Get the script `wordpos.js` and use it. (npm module may be coming.)
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).
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.
WordPOS is a subclass of natural's [WordNet class](https://github.com/NaturalNode/natural#wordnet) and inherits call its methods.
### getX()
@ -155,8 +154,10 @@ In this case only one lookup was found. But there could be several.
Or use WordNet's inherited method directly:
```js
wordpos.lookup('great', console.log);
// ...
```
Benchmark
----------