Ikala-allen commited on
Commit
0aa8c44
1 Parent(s): 2ba8921

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -2
README.md CHANGED
@@ -44,8 +44,8 @@ evaluation_scores = module.compute(predictions=predictions, references=reference
44
  ```
45
 
46
  ### Inputs
47
- - **predictions** (`list` of `list` of `dictionary`): A list of predicted relations from the model.
48
- - **references** (`list` of `list` of `dictionary`): A list of ground-truth or reference relations to compare the predictions against.
49
  - **mode** (`str`): Evaluation mode - 'strict' or 'boundaries'. 'strict' mode takes into account both entities type and their relationships, while 'boundaries' mode only considers the entity spans of the relationships.
50
  - **detailed_scores** (`bool`): If True it returns scores for each relation type specifically, if False it returns the overall scores.
51
  - **relation_types** (`list`): A list of relation types to consider while evaluating. If not provided, relation types will be constructed from the ground truth or reference data.
 
44
  ```
45
 
46
  ### Inputs
47
+ - **predictions** (`list` of `list` of `dictionary`): A list of list of dictionary predicted relations from the model.
48
+ - **references** (`list` of `list` of `dictionary`): A list of list of dictionary ground-truth or reference relations to compare the predictions against.
49
  - **mode** (`str`): Evaluation mode - 'strict' or 'boundaries'. 'strict' mode takes into account both entities type and their relationships, while 'boundaries' mode only considers the entity spans of the relationships.
50
  - **detailed_scores** (`bool`): If True it returns scores for each relation type specifically, if False it returns the overall scores.
51
  - **relation_types** (`list`): A list of relation types to consider while evaluating. If not provided, relation types will be constructed from the ground truth or reference data.