nbansal commited on
Commit
431fa5b
1 Parent(s): 90d2f63
Files changed (1) hide show
  1. README.md +8 -2
README.md CHANGED
@@ -46,14 +46,19 @@ It also accepts multiple optional arguments:
46
  TODO: List optional arguments
47
 
48
  ### Inputs
 
49
  *List all input arguments in the format below*
50
  - **input_field** *(type): Definition of input, with explanation if necessary. State any default value(s).*
51
 
52
  ### Output Values
53
 
54
- *Explain what this metric outputs and provide an example of what the metric output looks like. Modules should return a dictionary with one or multiple key-value pairs, e.g. {"bleu" : 6.02}*
55
 
56
- *State the range of possible values that the metric's output can take, as well as what in that range is considered good. For example: "This metric can take on any value between 0 and 100, inclusive. Higher scores are better."*
 
 
 
 
57
 
58
  #### Values from Popular Papers
59
  *Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported.*
@@ -87,5 +92,6 @@ TODO: List optional arguments
87
  ```
88
 
89
  ## Further References
 
90
  - [Paper](https://aclanthology.org/2022.emnlp-main.49/)
91
  - [Presentation Slides]()
 
46
  TODO: List optional arguments
47
 
48
  ### Inputs
49
+ TODO:
50
  *List all input arguments in the format below*
51
  - **input_field** *(type): Definition of input, with explanation if necessary. State any default value(s).*
52
 
53
  ### Output Values
54
 
55
+ BERTScore outputs a dictionary with the following values:
56
 
57
+ `precision`: The [precision](https://huggingface.co/metrics/precision) for each system summary, which ranges from 0.0 to 1.0.
58
+
59
+ `recall`: The [recall](https://huggingface.co/metrics/recall) for each system summary, which ranges from 0.0 to 1.0.
60
+
61
+ `f1`: The [F1 score](https://huggingface.co/metrics/f1) for each system summary, which ranges from 0.0 to 1.0.
62
 
63
  #### Values from Popular Papers
64
  *Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported.*
 
92
  ```
93
 
94
  ## Further References
95
+ TODO: Add links to the slides and video
96
  - [Paper](https://aclanthology.org/2022.emnlp-main.49/)
97
  - [Presentation Slides]()