msaidov commited on
Commit
bcbd486
1 Parent(s): 727cfeb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -1
README.md CHANGED
@@ -10,4 +10,41 @@ pinned: false
10
  license: apache-2.0
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: apache-2.0
11
  ---
12
 
13
+ ---
14
+ title: Bary Score
15
+ datasets:
16
+ -
17
+ tags:
18
+ - evaluate
19
+ - metric
20
+ description: "TODO: add a description here"
21
+ sdk: gradio
22
+ sdk_version: 3.0.2
23
+ app_file: app.py
24
+ pinned: false
25
+ ---
26
+
27
+ # Metric Card for Bary Score
28
+
29
+ ***Module Card Instructions:*** *Fill out the following subsections. Feel free to take a look at existing metric cards if you'd like examples.*
30
+ ## Metric Description
31
+ *Give a brief overview of this metric, including what task(s) it is usually used for, if any.*
32
+ ## How to Use
33
+ *Give general statement of how to use the metric*
34
+ *Provide simplest possible example for using the metric*
35
+ ### Inputs
36
+ *List all input arguments in the format below*
37
+ - **input_field** *(type): Definition of input, with explanation if necessary. State any default value(s).*
38
+ ### Output Values
39
+ *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}*
40
+ *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."*
41
+ #### Values from Popular Papers
42
+ *Give examples, preferrably with links to leaderboards or publications, to papers that have reported this metric, along with the values they have reported.*
43
+ ### Examples
44
+ *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.*
45
+ ## Limitations and Bias
46
+ *Note any known limitations or biases that the metric has, with links and references if possible.*
47
+ ## Citation
48
+ *Cite the source where this metric was introduced.*
49
+ ## Further References
50
+ *Add any useful further references.*