Improve model card: Add metadata, link to code, and model description

#1
by nielsr HF staff - opened
Files changed (1) hide show
  1. README.md +31 -75
README.md CHANGED
@@ -1,127 +1,94 @@
1
  ---
2
  library_name: transformers
3
  tags: []
 
 
4
  ---
5
 
6
  # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
  ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
  - **Demo [optional]:** [More Information Needed]
35
 
36
  ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
  ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
 
46
  ### Downstream Use [optional]
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
  [More Information Needed]
51
 
52
  ### Out-of-Scope Use
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
 
64
  ### Recommendations
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
  ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
78
  ### Training Data
79
 
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
 
84
  ### Training Procedure
85
 
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
 
88
  #### Preprocessing [optional]
89
 
90
  [More Information Needed]
91
 
92
-
93
  #### Training Hyperparameters
94
 
95
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
 
97
  #### Speeds, Sizes, Times [optional]
98
 
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
  [More Information Needed]
102
 
103
  ## Evaluation
104
 
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
  ### Testing Data, Factors & Metrics
108
 
109
  #### Testing Data
110
 
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
 
115
  #### Factors
116
 
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
  [More Information Needed]
120
 
121
  #### Metrics
122
 
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
  [More Information Needed]
126
 
127
  ### Results
@@ -130,25 +97,15 @@ Use the code below to get started with the model.
130
 
131
  #### Summary
132
 
133
-
134
 
135
  ## Model Examination [optional]
136
 
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
  [More Information Needed]
140
 
141
  ## Environmental Impact
142
 
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
 
153
  ## Technical Specifications [optional]
154
 
@@ -170,20 +127,19 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
170
 
171
  ## Citation [optional]
172
 
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
 
182
 
183
  ## Glossary [optional]
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
  [More Information Needed]
188
 
189
  ## More Information [optional]
 
1
  ---
2
  library_name: transformers
3
  tags: []
4
+ pipeline_tag: text-generation
5
+ license: apache-2.0
6
  ---
7
 
8
  # Model Card for Model ID
9
 
10
+ This model is an evaluator language model, trained on the BiGGen Bench, designed to evaluate the performance of other language models across a wide range of tasks and capabilities.
 
 
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
+ Prometheus 2 BGB (8x7B) is an open-source language model fine-tuned for evaluating other language models. It is trained on the BiGGen Bench and uses instance-specific evaluation criteria to provide more nuanced and granular assessments than traditional benchmarks.
 
 
17
 
18
+ - **Developed by:** KAIST AI
19
+ - **Model type:** Large Language Model (LLM) - Evaluator
20
+ - **Language(s) (NLP):** English
21
+ - **License:** Apache 2.0
22
+ - **Finetuned from model [optional]:** Mixtral-8x7B
 
 
23
 
24
  ### Model Sources [optional]
25
 
26
+ - **Repository:** [https://github.com/prometheus-eval/prometheus-eval/tree/main/BiGGen-Bench](https://github.com/prometheus-eval/prometheus-eval/tree/main/BiGGen-Bench)
27
+ - **Paper [optional]:** [https://arxiv.org/abs/2406.05761](https://arxiv.org/abs/2406.05761)
 
 
28
  - **Demo [optional]:** [More Information Needed]
29
 
30
  ## Uses
31
 
 
 
32
  ### Direct Use
33
 
34
+ Prometheus 2 BGB (8x7B) can be used directly to evaluate the outputs of other language models. It supports both direct assessment (absolute grading) and pairwise ranking (relative grading) formats.
 
 
35
 
36
  ### Downstream Use [optional]
37
 
 
 
38
  [More Information Needed]
39
 
40
  ### Out-of-Scope Use
41
 
42
+ This model is designed specifically for evaluating other language models. Its use for general text generation or other unrelated tasks is not recommended.
 
 
43
 
44
  ## Bias, Risks, and Limitations
45
 
46
+ As a language model, Prometheus 2 BGB (8x7B) may exhibit biases present in its training data. Evaluations should be interpreted cautiously and considered alongside other evaluation methods.
 
 
47
 
48
  ### Recommendations
49
 
50
+ Users should be aware of potential biases and limitations and interpret evaluations critically. Employ multiple evaluation methods to get a more comprehensive assessment of LLM performance.
 
 
51
 
52
  ## How to Get Started with the Model
53
 
54
+ Refer to the [Prometheus-Eval](https://github.com/prometheus-eval/prometheus-eval) GitHub repository for instructions on using this model.
 
 
55
 
56
  ## Training Details
57
 
58
  ### Training Data
59
 
60
+ The model was trained on the BiGGen Bench dataset.
 
 
61
 
62
  ### Training Procedure
63
 
64
+ [More Information Needed]
65
 
66
  #### Preprocessing [optional]
67
 
68
  [More Information Needed]
69
 
 
70
  #### Training Hyperparameters
71
 
72
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
73
 
74
  #### Speeds, Sizes, Times [optional]
75
 
 
 
76
  [More Information Needed]
77
 
78
  ## Evaluation
79
 
 
 
80
  ### Testing Data, Factors & Metrics
81
 
82
  #### Testing Data
83
 
84
+ The BiGGen Bench dataset was used for evaluation, covering nine distinct capabilities of LLMs across 77 diverse tasks. Metrics include both absolute and relative grading scores.
 
 
85
 
86
  #### Factors
87
 
 
 
88
  [More Information Needed]
89
 
90
  #### Metrics
91
 
 
 
92
  [More Information Needed]
93
 
94
  ### Results
 
97
 
98
  #### Summary
99
 
100
+ [More Information Needed]
101
 
102
  ## Model Examination [optional]
103
 
 
 
104
  [More Information Needed]
105
 
106
  ## Environmental Impact
107
 
108
+ [More Information Needed]
 
 
 
 
 
 
 
 
109
 
110
  ## Technical Specifications [optional]
111
 
 
127
 
128
  ## Citation [optional]
129
 
130
+ ```bibtex
131
+ @misc{kim2024biggen,
132
+ title={The BiGGen Bench: A Principled Benchmark for Fine-grained Evaluation of Language Models with Language Models},
133
+ author={Seungone Kim and Juyoung Suk and Ji Yong Cho and Shayne Longpre and Chaeeun Kim and Dongkeun Yoon and Guijin Son and Yejin Cho and Sheikh Shafayat and Jinheon Baek and Sue Hyun Park and Hyeonbin Hwang and Jinkyung Jo and Hyowon Cho and Haebin Shin and Seongyun Lee and Hanseok Oh and Noah Lee and Namgyu Ho and Se June Joo and Miyoung Ko and Yoonjoo Lee and Hyungjoo Chae and Jamin Shin and Joel Jang and Seonghyeon Ye and Bill Yuchen Lin and Sean Welleck and Graham Neubig and Moontae Lee and Kyungjae Lee and Minjoon Seo},
134
+ year={2024},
135
+ eprint={2406.05761},
136
+ archivePrefix={arXiv},
137
+ primaryClass={cs.CL}
138
+ }
139
+ ```
140
 
141
  ## Glossary [optional]
142
 
 
 
143
  [More Information Needed]
144
 
145
  ## More Information [optional]