Update README.md

README.md

@@ -124,16 +124,41 @@ To have a complete explanation of each process element tag please refer to the [
 ### Relations Extraction
 - *document name*: a string used to represent the name of the document.
 - *tokens*: a list of string representing the words of the document
-- *tokens-IDs*: a list of interger representing the word position within a sentence
-- *sentence-IDs*: a list of interger representing the sentence number for each word of the document
-- *relations*:: a list of document relations
-  - *source-head-sentence-ID*: a list of sentence ID of the source head , 
-  - *source-head-word-ID*: a list of 
-  - *relation-type*: a list of 
-  - *target-head-sentence-ID*: a list of 
-  - *target-head-word-ID*: a list of 
-
-
+- *tokens-IDs*: a list of interger representing the word position within a sentence.
+- *ner_tags*: a list of string representing the annotation for each word. (see ner-tags above)
+- *sentence-IDs*: a list of interger representing the sentence number for each word of the document.
+- *relations*:: a list of document relations.
+  - *source-head-sentence-ID*: a list of sentence ID pointing to the sentence number of the head (first token) of the source entity.
+  - *source-head-word-ID*: a list of token ID pointing to the word ID of the head (first token) of the source entity.
+  - *relation-type*: a list of relation tags.
+  - *target-head-sentence-ID*: a list of sentence ID pointing to the sentence number of the head (first token) of the target entity.
+  - *target-head-word-ID*: a list of token ID pointing to the word ID of the head (first token) of the target entity.
+
+For instance, a relation is defined by the instances of *source-head-sentence-ID*, *source-head-word-ID*, *relation-type*, *target-head-sentence-ID*, and *target-head-word-ID* at the same index position.
+In the following example, the first relation of the first document is shown:
+```python
+document_1=modelhub_dataset['test'][0]
+relation = {
+            'source-head-sentence-ID': document_1['relations']['source-head-sentence-ID'][0],
+            'source-head-word-ID': document_1['relations']['source-head-word-ID'][0],
+            'relation-type': document_1['relations']['relation-type'][0],
+            'target-head-sentence-ID': document_1['relations']['target-head-sentence-ID'][0],
+            'target-head-word-ID': document_1['relations']['target-head-sentence-ID'][0],
+          }
+print(relation)          
+```
+the output is:
+```python
+{'relation-type': 'uses',
+ 'source-head-sentence-ID': 1,
+ 'source-head-word-ID': 4,
+ 'target-head-sentence-ID': 1,
+ 'target-head-word-ID': 1}
+```
+That means:
+  the entity in sentence number *1*, starting at the token position *4* has a *uses* relation with the entity in sentence number *1* starting at token position *1*
+  
+  
 ### Data Splits
 
 The data was not splited. It contains the test set only.