Spaces:
Sleeping
Sleeping
Victoria Oberascher
commited on
Commit
·
d0f1574
1
Parent(s):
aee59a3
fix bug in README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,8 @@
|
|
| 1 |
---
|
| 2 |
title: horizonmetrics
|
| 3 |
-
datasets:
|
| 4 |
-
-
|
| 5 |
tags:
|
| 6 |
-
- evaluate
|
| 7 |
-
- metric
|
| 8 |
description: "TODO: add a description here"
|
| 9 |
sdk: gradio
|
| 10 |
sdk_version: 3.19.1
|
|
@@ -14,37 +12,46 @@ pinned: false
|
|
| 14 |
|
| 15 |
# Metric Card for horizonmetrics
|
| 16 |
|
| 17 |
-
|
| 18 |
|
| 19 |
## Metric Description
|
| 20 |
-
|
|
|
|
| 21 |
|
| 22 |
## How to Use
|
| 23 |
-
*Give general statement of how to use the metric*
|
| 24 |
|
| 25 |
-
|
|
|
|
|
|
|
| 26 |
|
| 27 |
### Inputs
|
| 28 |
-
|
| 29 |
-
|
|
|
|
|
|
|
| 30 |
|
| 31 |
### Output Values
|
| 32 |
|
| 33 |
-
|
| 34 |
|
| 35 |
-
|
| 36 |
|
| 37 |
#### Values from Popular Papers
|
| 38 |
-
|
|
|
|
| 39 |
|
| 40 |
### Examples
|
| 41 |
-
|
|
|
|
| 42 |
|
| 43 |
## Limitations and Bias
|
| 44 |
-
|
|
|
|
| 45 |
|
| 46 |
## Citation
|
| 47 |
-
|
|
|
|
| 48 |
|
| 49 |
## Further References
|
| 50 |
-
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: horizonmetrics
|
|
|
|
|
|
|
| 3 |
tags:
|
| 4 |
+
- evaluate
|
| 5 |
+
- metric
|
| 6 |
description: "TODO: add a description here"
|
| 7 |
sdk: gradio
|
| 8 |
sdk_version: 3.19.1
|
|
|
|
| 12 |
|
| 13 |
# Metric Card for horizonmetrics
|
| 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 |
+
|
| 19 |
+
_Give a brief overview of this metric, including what task(s) it is usually used for, if any._
|
| 20 |
|
| 21 |
## How to Use
|
|
|
|
| 22 |
|
| 23 |
+
_Give general statement of how to use the metric_
|
| 24 |
+
|
| 25 |
+
_Provide simplest possible example for using the metric_
|
| 26 |
|
| 27 |
### Inputs
|
| 28 |
+
|
| 29 |
+
_List all input arguments in the format below_
|
| 30 |
+
|
| 31 |
+
- **input_field** _(type): Definition of input, with explanation if necessary. State any default value(s)._
|
| 32 |
|
| 33 |
### Output Values
|
| 34 |
|
| 35 |
+
_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}_
|
| 36 |
|
| 37 |
+
_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."_
|
| 38 |
|
| 39 |
#### Values from Popular Papers
|
| 40 |
+
|
| 41 |
+
_Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported._
|
| 42 |
|
| 43 |
### Examples
|
| 44 |
+
|
| 45 |
+
_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._
|
| 46 |
|
| 47 |
## Limitations and Bias
|
| 48 |
+
|
| 49 |
+
_Note any known limitations or biases that the metric has, with links and references if possible._
|
| 50 |
|
| 51 |
## Citation
|
| 52 |
+
|
| 53 |
+
_Cite the source where this metric was introduced._
|
| 54 |
|
| 55 |
## Further References
|
| 56 |
+
|
| 57 |
+
_Add any useful further references._
|