bascobasculino commited on
Commit
c09fee3
1 Parent(s): 8708085
Files changed (1) hide show
  1. README.md +0 -32
README.md CHANGED
@@ -14,35 +14,3 @@ pinned: false
14
 
15
  ***Module Card Instructions:*** *Fill out the following subsections. Feel free to take a look at existing metric cards if you'd like examples.*
16
 
17
- ## Metric Description
18
- *Give a brief overview of this metric, including what task(s) it is usually used for, if any.*
19
-
20
- ## How to Use
21
- *Give general statement of how to use the metric*
22
-
23
- *Provide simplest possible example for using the metric*
24
-
25
- ### Inputs
26
- *List all input arguments in the format below*
27
- - **input_field** *(type): Definition of input, with explanation if necessary. State any default value(s).*
28
-
29
- ### Output Values
30
-
31
- *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}*
32
-
33
- *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."*
34
-
35
- #### Values from Popular Papers
36
- *Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported.*
37
-
38
- ### Examples
39
- *Give code examples of the metric being used. Try to include examples that clear up any potential ambiguity left from the metric description above. If possible, provide a range of examples that show both typical and atypical results, as well as examples where a variety of input parameters are passed.*
40
-
41
- ## Limitations and Bias
42
- *Note any known limitations or biases that the metric has, with links and references if possible.*
43
-
44
- ## Citation
45
- *Cite the source where this metric was introduced.*
46
-
47
- ## Further References
48
- *Add any useful further references.*
 
14
 
15
  ***Module Card Instructions:*** *Fill out the following subsections. Feel free to take a look at existing metric cards if you'd like examples.*
16