File size: 1,977 Bytes
3e1f4f6
 
614c2f5
cf22e33
614c2f5
cf22e33
 
614c2f5
3e1f4f6
614c2f5
3e1f4f6
 
 
 
614c2f5
 
cf22e33
614c2f5
 
cf22e33
 
614c2f5
 
 
cf22e33
 
 
614c2f5
 
cf22e33
 
 
 
614c2f5
 
 
cf22e33
614c2f5
cf22e33
614c2f5
 
cf22e33
 
614c2f5
 
cf22e33
 
614c2f5
 
cf22e33
 
614c2f5
 
cf22e33
 
614c2f5
 
cf22e33
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
title: Awesome Metric
datasets:
  - squad
tags:
  - evaluate
  - metric
description: "TODO: add a description here"
sdk: gradio
sdk_version: 3.19.1
app_file: app.py
pinned: false
---

# Metric Card for Awesome Metric

**_Module Card Instructions:_** _Fill out the following subsections. Feel free to take a look at existing metric cards if you'd like examples._

## Metric Description

_Give a brief overview of this metric, including what task(s) it is usually used for, if any._

## How to Use

_Give general statement of how to use the metric_

_Provide simplest possible example for using the metric_

### Inputs

_List all input arguments in the format below_

- **input_field** _(type): Definition of input, with explanation if necessary. State any default value(s)._

### Output Values

_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}_

_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."_

#### Values from Popular Papers

_Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported._

### Examples

_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._

## Limitations and Bias

_Note any known limitations or biases that the metric has, with links and references if possible._

## Citation

_Cite the source where this metric was introduced._

## Further References

_Add any useful further references._