updated doc and added license
This commit is contained in:
1 parent
fd9b9664c5
commit
b63ef7f3ea
2 files changed
+38
-19
No files matched your search
@@ -0,0 +1,18 @@
|
|||||||
|
Copyright (c) 2015-2016 Amit Lavon
|
||||||
|
|
||||||
|
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 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.
|
||||||
@@ -17,13 +17,13 @@ An entire WordNet database.
|
|||||||
|
|
||||||
Fields:
|
Fields:
|
||||||
|
|
||||||
* **Synset** (map to [Synset](#synset)) from synset ID to synset object.
|
* **synset** (map to [Synset](#synset)) from synset ID to synset object.
|
||||||
* **Lemma** (map to string array) from pos.lemma to synset IDs that contain it.
|
* **lemma** (map to string array) from pos.lemma to synset IDs that contain it.
|
||||||
* **LemmaRanked** (map to string array) like Lemma but synsets are ordered from the
|
* **lemmaRanked** (map to string array) like Lemma but synsets are ordered from the
|
||||||
most frequently used to the least. Only a subset of the synsets are ranked, so
|
most frequently used to the least. Only a subset of the synsets are ranked, so
|
||||||
LemmaRanked has less synsets.
|
LemmaRanked has less synsets.
|
||||||
* **Exception** (map to string array) from exceptional word to its forms.
|
* **exception** (map to string array) from exceptional word to its forms.
|
||||||
* **Example** (map to string) from example ID to sentence template.
|
* **example** (map to string) from example ID to sentence template.
|
||||||
|
|
||||||
#### Synset
|
#### Synset
|
||||||
|
|
||||||
@@ -31,12 +31,13 @@ A set of synonymous words.
|
|||||||
|
|
||||||
Fields:
|
Fields:
|
||||||
|
|
||||||
* **Pos** (string) part of speech - a, n, r, s, v.
|
* **offset** (int) synset offset, also used as an identifier.
|
||||||
* **Word** (string array) words in this synset
|
* **pos** (string) part of speech - a, n, r, s, v.
|
||||||
* **Pointer** ([Pointer](#pointer) array) pointers to other synsets.
|
* **word** (string array) words in this synset.
|
||||||
* **Frame** ([Frame](#frame) array) sentence frames for verbs.
|
* **pointer** ([Pointer](#pointer) array) pointers to other synsets.
|
||||||
* **Gloss** (string) lexical definition.
|
* **frame** ([Frame](#frame) array) sentence frames for verbs.
|
||||||
* **Example** ([Example](#example) array) usage examples for words in this synset. Verbs only.
|
* **gloss** (string) lexical definition.
|
||||||
|
* **example** ([Example](#example) array) usage examples for words in this synset. Verbs only.
|
||||||
|
|
||||||
#### Pointer
|
#### Pointer
|
||||||
|
|
||||||
@@ -44,11 +45,11 @@ Denotes a semantic relation between one synset/word to another.
|
|||||||
|
|
||||||
Fields:
|
Fields:
|
||||||
|
|
||||||
* **Symbol** (string) relation between the 2 words. Target is \<symbol\> to source. See their meanings
|
* **symbol** (string) relation between the 2 words. Target is \<symbol\> to source. See their meanings
|
||||||
[here](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet#pkg-constants).
|
[here](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet#pkg-constants).
|
||||||
* **Synset** (string) target synset ID.
|
* **synset** (string) target synset ID.
|
||||||
* **Source** (int) index of word in source synset, -1 for entire synset.
|
* **source** (int) index of word in source synset, -1 for entire synset.
|
||||||
* **Target** (int) index of word in target synset, -1 for entire synset.
|
* **target** (int) index of word in target synset, -1 for entire synset.
|
||||||
|
|
||||||
#### Frame
|
#### Frame
|
||||||
|
|
||||||
@@ -56,8 +57,8 @@ Links a synset word to a generic phrase that illustrates how to use it. Applies
|
|||||||
|
|
||||||
Fields:
|
Fields:
|
||||||
|
|
||||||
* **WordNumber** (int) index of word in the containing synset, -1 for entire synset.
|
* **wordNumber** (int) index of word in the containing synset, -1 for entire synset.
|
||||||
* **FrameNumber** (int) frame number on the WordNet site.
|
* **frameNumber** (int) frame number on the WordNet site.
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
@@ -65,8 +66,8 @@ Links a synset word to an example sentence. Applies to verbs only.
|
|||||||
|
|
||||||
Fields:
|
Fields:
|
||||||
|
|
||||||
* **WordNumber** (int) index of word in the containing synset, -1 for entire synset.
|
* **wordNumber** (int) index of word in the containing synset, -1 for entire synset.
|
||||||
* **TemplateNumber** (int) tumber of template in the [WordNet](#wordnet).Example field.
|
* **templateNumber** (int) tumber of template in the [WordNet](#wordnet).Example field.
|
||||||
|
|
||||||
Go API
|
Go API
|
||||||
------
|
------
|
||||||
|
|||||||
Reference in new issue
Block a user