Ikala-allen commited on
Commit
12cbf3e
1 Parent(s): edbf893

Update README.md

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