Transformers
Safetensors
PEFT
Inference Endpoints
psiyum commited on
Commit
2d6f185
1 Parent(s): 3d5bbe7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -183
README.md CHANGED
@@ -9,197 +9,31 @@ datasets:
9
  - calibration-tuning/Llama-2-13b-chat-hf-20k-choice
10
  ---
11
 
12
- # Model Card for Model ID
13
 
14
- <!-- Provide a quick summary of what the model is/does. -->
15
 
 
 
 
16
 
 
17
 
18
- ## Model Details
19
 
20
- ### Model Description
21
 
22
- <!-- Provide a longer summary of what this model is. -->
 
 
 
23
 
24
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
25
 
26
- - **Developed by:** [More Information Needed]
27
- - **Funded by [optional]:** [More Information Needed]
28
- - **Shared by [optional]:** [More Information Needed]
29
- - **Model type:** [More Information Needed]
30
- - **Language(s) (NLP):** [More Information Needed]
31
- - **License:** [More Information Needed]
32
- - **Finetuned from model [optional]:** [More Information Needed]
33
 
34
- ### Model Sources [optional]
35
 
36
- <!-- Provide the basic links for the model. -->
37
 
38
- - **Repository:** [More Information Needed]
39
- - **Paper [optional]:** [More Information Needed]
40
- - **Demo [optional]:** [More Information Needed]
41
-
42
- ## Uses
43
-
44
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
45
-
46
- ### Direct Use
47
-
48
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
49
-
50
- [More Information Needed]
51
-
52
- ### Downstream Use [optional]
53
-
54
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
-
56
- [More Information Needed]
57
-
58
- ### Out-of-Scope Use
59
-
60
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
61
-
62
- [More Information Needed]
63
-
64
- ## Bias, Risks, and Limitations
65
-
66
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
67
-
68
- [More Information Needed]
69
-
70
- ### Recommendations
71
-
72
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
73
-
74
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
75
-
76
- ## How to Get Started with the Model
77
-
78
- Use the code below to get started with the model.
79
-
80
- [More Information Needed]
81
-
82
- ## Training Details
83
-
84
- ### Training Data
85
-
86
- <!-- 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. -->
87
-
88
- [More Information Needed]
89
-
90
- ### Training Procedure
91
-
92
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
93
-
94
- #### Preprocessing [optional]
95
-
96
- [More Information Needed]
97
-
98
-
99
- #### Training Hyperparameters
100
-
101
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
102
-
103
- #### Speeds, Sizes, Times [optional]
104
-
105
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
106
-
107
- [More Information Needed]
108
-
109
- ## Evaluation
110
-
111
- <!-- This section describes the evaluation protocols and provides the results. -->
112
-
113
- ### Testing Data, Factors & Metrics
114
-
115
- #### Testing Data
116
-
117
- <!-- This should link to a Dataset Card if possible. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Factors
122
-
123
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
124
-
125
- [More Information Needed]
126
-
127
- #### Metrics
128
-
129
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
130
-
131
- [More Information Needed]
132
-
133
- ### Results
134
-
135
- [More Information Needed]
136
-
137
- #### Summary
138
-
139
-
140
-
141
- ## Model Examination [optional]
142
-
143
- <!-- Relevant interpretability work for the model goes here -->
144
-
145
- [More Information Needed]
146
-
147
- ## Environmental Impact
148
-
149
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
150
-
151
- 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).
152
-
153
- - **Hardware Type:** [More Information Needed]
154
- - **Hours used:** [More Information Needed]
155
- - **Cloud Provider:** [More Information Needed]
156
- - **Compute Region:** [More Information Needed]
157
- - **Carbon Emitted:** [More Information Needed]
158
-
159
- ## Technical Specifications [optional]
160
-
161
- ### Model Architecture and Objective
162
-
163
- [More Information Needed]
164
-
165
- ### Compute Infrastructure
166
-
167
- [More Information Needed]
168
-
169
- #### Hardware
170
-
171
- [More Information Needed]
172
-
173
- #### Software
174
-
175
- [More Information Needed]
176
-
177
- ## Citation [optional]
178
-
179
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
180
-
181
- **BibTeX:**
182
-
183
- [More Information Needed]
184
-
185
- **APA:**
186
-
187
- [More Information Needed]
188
-
189
- ## Glossary [optional]
190
-
191
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
192
-
193
- [More Information Needed]
194
-
195
- ## More Information [optional]
196
-
197
- [More Information Needed]
198
-
199
- ## Model Card Authors [optional]
200
-
201
- [More Information Needed]
202
-
203
- ## Model Card Contact
204
-
205
- [More Information Needed]
 
9
  - calibration-tuning/Llama-2-13b-chat-hf-20k-choice
10
  ---
11
 
12
+ # Model Card
13
 
14
+ **Llama 13B Chat CT-Choice** is a fine-tuned [Llama 13B Chat](https://huggingface.co/meta-llama/Llama-2-13b-chat-hf) model that provides well-calibrated confidence estimates for multiple-choice question answering.
15
 
16
+ The model is fine-tuned (calibration-tuned) using a [dataset](https://huggingface.co/datasets/calibration-tuning/Llama-2-13b-chat-hf-20k-choice) of *multiple-choice* generations from `meta-llama/Llama-2-13b-chat-hf`, labeled for correctness.
17
+ At test/inference time, the probability of correctness defines the confidence of the model in its answer.
18
+ For full details, please see our [paper](https://arxiv.org/) and supporting [code](https://github.com/activatedgeek/calibration-tuning).
19
 
20
+ **Other Models**: We also release a broader collection of [Multiple-Choice CT Models](https://huggingface.co/collections/calibration-tuning/multiple-choice-ct-models-66043dedebf973d639090821).
21
 
22
+ ## Usage
23
 
24
+ This adapter model is meant to be used on top of `meta-llama/Llama-2-13b-chat-hf` model generations.
25
 
26
+ The confidence estimation pipeline follows these steps,
27
+ 1. Load base model and PEFT adapter.
28
+ 2. Disable adapter and generate answer.
29
+ 3. Enable adapter and generate confidence.
30
 
31
+ All standard guidelines for the base model's generation apply.
32
 
33
+ For a complete example, see [play.py](https://github.com/activatedgeek/calibration-tuning/blob/main/experiments/play.py) at the supporting code repository.
 
 
 
 
 
 
34
 
35
+ **NOTE**: Using the adapter for generations may hurt downstream task accuracy and confidence estimates. We recommend using the adapter to estimate *only* confidence.
36
 
37
+ ## License
38
 
39
+ The model is released under the original model's Apache 2.0 license.