Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rm-hull/clj-wordnet
An interface to the WordNet database using idiomatic Clojure
https://github.com/rm-hull/clj-wordnet
Last synced: about 1 month ago
JSON representation
An interface to the WordNet database using idiomatic Clojure
- Host: GitHub
- URL: https://github.com/rm-hull/clj-wordnet
- Owner: rm-hull
- License: other
- Created: 2013-05-30T00:23:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-14T16:13:30.000Z (over 9 years ago)
- Last Synced: 2024-10-03T12:17:31.184Z (about 2 months ago)
- Language: Clojure
- Homepage:
- Size: 285 KB
- Stars: 35
- Watchers: 5
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Clj-WordNet [](http://travis-ci.org/delver/clj-wordnet)
A thin/partial wrapper around some [JWI](http://projects.csail.mit.edu/jwi/)
functionality, for interfacing the [WordNet](http://wordnet.princeton.edu/)
database using idiomatic Clojure.
## Prerequisites
You will need [Leiningen](https://github.com/technomancy/leiningen)
2.3.4 or above installed.
## Building
To build and install the library locally, run:
$ git submodule update --init data
$ lein test
$ lein install
## Including in your project
There is an initial version hosted at [Clojars](https://clojars.org/clj-wordnet/clj-wordnet).
For leiningen include a dependency:
```clojure
[clj-wordnet "0.1.0"]
```
For maven-based projects, add the following to your `pom.xml`:
```xml
clj-wordnet
clj-wordnet
0.1.0
```
A snapshot version is also available, use ```"0.1.1-SNAPSHOT"```.
## WordNet Database
The WordNet database is not bundled in this project; it is _referenced_
via a git submodule, in order to run integration tests. In order to
ensure the submodule is properly initialised, follow the build
instructions above.
## Quick Examples
```clojure
(def wordnet (make-dictionary "../path-to/wordnet/dict/"))
(def dog (first (wordnet "dog" :noun)))
(:lemma dog)
=> "dog"
(:pos dog)
=> :noun
(:gloss dog)
=> "a member of the genus Canis (probably descended from the common wolf) that
has been domesticated by man since prehistoric times; occurs in many breeds;
\"the dog barked all night\""
(map :lemma (words (:synset dog))
=> ("dog" "domestic_dog", "Canis_familiaris")
(def frump (first (wordnet "frump" :noun)))
(map :lemma (related-words frump :derivationally-related))
=> ("frumpy")
(map :lemma (flatten (vals (related-synsets dog :hypernym))))
=> ("domestic_animal" "domesticated_animal" "canine" "canid")
```
## Dictionary
The default dictionary will load definitions from the database as needed
and they will be cached as necessary. If higher performance is required
and there is sufficient memory available to the JVM, then the dictionary
can be made to be resident entirely in memory, as below. This will force
an immediate load of the dictionary into RAM, where there may be a
perceptible delay on startup.
```clojure
(def wordnet (make-dictionary "../path-to/wordnet/dict/" :in-memory))
```
Note: Wordnet is quite large, and usually won’t fit into the standard heap on most
32-bit JVMs. You need to increase your heap size. On the Sun JVM, this involves
the command line flag -Xmx along with a reasonable heap size, say, 500 MB or 1 GB.
## Word Lookup
Word definitions can be fetched using the ```make-dictionary``` factory as per the
example below:
```clojure
(def wordnet (make-dictionary "../path-to/wordnet/dict/"))
(wordnet "car#n#1") ; fetch the first noun definition for car
(wordnet "bus") ; fetch a list of all definitions for bus
(wordnet "row" :noun) ; fetch a list of all noun definitions for row
(wordnet "row#v#1") ; fetch the single verb definition for row
(wordnet "WID-02086723-N-01-dog" ; fetch the word with the specified ID
(wordnet "SID-02086723-N" ; fetch the synset with the specified ID
```
## See Also
The JWI has been mavenized and rolled up into a github repo, here: https://github.com/delver/jwi.
The resulting artifacts have been deployed to http://repo.delver.io/releases, and this has been
referenced in this project's repository resolution section.
## TODO
* ~~Implement ```(make-dictionary "../path-to/wordnet/dict/" :in-memory)``` to use
RAM-based dictionary~~
* ~~Coerce functions into separate namespace~~
* ~~Re-implement ```(related-synsets ...)``` and ```(related-words ...)```~~
* ~~Push JWI 2.2.4 to central repository~~
* ~~Unit tests & Travis CI~~
* Implement more similarity algorithms
* Improve performance
## License
Same as JWI: MIT / [Creative Commons 3.0](http://creativecommons.org/licenses/by/3.0/legalcode)