From 23006cb24c2a42a47b726437364c92c94691bf79 Mon Sep 17 00:00:00 2001 From: Amit Lavon Date: Fri, 18 Mar 2016 10:32:29 +0200 Subject: [PATCH] updated readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index fdf0602..da84b69 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ struct. The main object in the file. +Fields: + * **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. * **Exception** (map to string array) from exceptional word to its forms. @@ -27,6 +29,8 @@ The main object in the file. A set of synonymous words. +Fields: + * **Pos** (string) part of speech - a, n, r, s, v. * **Word** (string array) words in this synset * **Pointer** ([Pointer](#pointer) array) pointers to other synsets. @@ -38,6 +42,8 @@ A set of synonymous words. Denotes a semantic relation between one synset/word to another. +Fields: + * **Symbol** (string) relation between the 2 words. Target is \ to source. See their meanings [here](https://godoc.org/github.com/fluhus/gostuff/nlp/wordnet#pkg-constants). * **Synset** (string) target synset ID. @@ -48,6 +54,8 @@ Denotes a semantic relation between one synset/word to another. Links a synset word to a generic phrase that illustrates how to use it. Applies to verbs only. +Fields: + * **WordNumber** (int) index of word in the containing synset, -1 for entire synset. * **FrameNumber** (int) frame number on the WordNet site. @@ -55,6 +63,8 @@ Links a synset word to a generic phrase that illustrates how to use it. Applies Links a synset word to an example sentence. Applies to verbs only. +Fields: + * **WordNumber** (int) index of word in the containing synset, -1 for entire synset. * **TemplateNumber** (int) tumber of template in the [WordNet](#wordnet).Example field.