isaacchung commited on
Commit
d0c79e1
1 Parent(s): 5b4e6cf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +47 -47
README.md CHANGED
@@ -17,54 +17,54 @@ Finetuned Llama3-8B-Instruct model on https://huggingface.co/datasets/isaacchung
17
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
18
 
19
  - **Developed by:** [Isaac Chung](https://huggingface.co/isaacchung)
20
- - **Funded by [optional]:** [More Information Needed]
21
- - **Shared by [optional]:** [More Information Needed]
22
- - **Model type:** [More Information Needed]
23
  - **Language(s) (NLP):** [English]
24
  - **License:** [Apache 2.0]
25
  - **Finetuned from model [optional]:** [meta-llama/Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
26
 
27
- ### Model Sources [optional]
28
 
29
  <!-- Provide the basic links for the model. -->
30
 
31
- - **Repository:** [More Information Needed]
32
  - **Paper [optional]:** [More Information Needed]
33
- - **Demo [optional]:** [More Information Needed]
34
 
35
- ## Uses
36
 
37
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
38
 
39
- ### Direct Use
40
 
41
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
42
 
43
- [More Information Needed]
44
 
45
- ### Downstream Use [optional]
46
 
47
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
48
 
49
- [More Information Needed]
50
 
51
- ### Out-of-Scope Use
52
 
53
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
54
 
55
- [More Information Needed]
56
 
57
- ## Bias, Risks, and Limitations
58
 
59
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
60
 
61
- [More Information Needed]
62
 
63
- ### Recommendations
64
 
65
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
66
 
67
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
68
 
69
  ## How to Get Started with the Model
70
 
@@ -77,7 +77,7 @@ tokenizer = AutoTokenizer.from_pretrained("isaacchung/llama3-8B-hotpotqa")
77
  model = AutoModelForCausalLM.from_pretrained("isaacchung/llama3-8B-hotpotqa")
78
  ```
79
 
80
- [More Information Needed]
81
 
82
  ## Training Details
83
 
@@ -86,20 +86,20 @@ model = AutoModelForCausalLM.from_pretrained("isaacchung/llama3-8B-hotpotqa")
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
  https://huggingface.co/datasets/isaacchung/hotpotqa-dev-raft-subset
88
 
89
- [More Information Needed]
90
 
91
  ### Training Procedure
92
 
93
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
 
95
- #### Preprocessing [optional]
96
 
97
- [More Information Needed]
98
 
99
 
100
  #### Training Hyperparameters
101
 
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
 
104
  Model loaded:
105
  ```python
@@ -160,54 +160,54 @@ trainer = SFTTrainer(
160
  )
161
  ```
162
 
163
- #### Speeds, Sizes, Times [optional]
164
 
165
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
166
 
167
- [More Information Needed]
168
 
169
- ## Evaluation
170
 
171
  <!-- This section describes the evaluation protocols and provides the results. -->
172
 
173
- ### Testing Data, Factors & Metrics
174
 
175
- #### Testing Data
176
 
177
  <!-- This should link to a Dataset Card if possible. -->
178
 
179
- [More Information Needed]
180
 
181
- #### Factors
182
 
183
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
184
 
185
- [More Information Needed]
186
 
187
- #### Metrics
188
 
189
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
190
 
191
- [More Information Needed]
192
 
193
- ### Results
194
 
195
- [More Information Needed]
196
 
197
- #### Summary
198
 
199
 
200
 
201
- ## Model Examination [optional]
202
 
203
  <!-- Relevant interpretability work for the model goes here -->
204
 
205
- [More Information Needed]
206
 
207
- ## Environmental Impact
208
 
209
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
210
-
211
  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).
212
 
213
  - **Hardware Type:** [More Information Needed]
@@ -229,8 +229,8 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
229
  #### Hardware
230
 
231
  [More Information Needed]
232
-
233
- #### Software
234
 
235
  [More Information Needed]
236
 
@@ -238,7 +238,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
238
 
239
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
240
 
241
- **BibTeX:**
242
 
243
  [More Information Needed]
244
 
@@ -246,20 +246,20 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
246
 
247
  [More Information Needed]
248
 
249
- ## Glossary [optional]
250
 
251
  <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
252
 
253
- [More Information Needed]
254
 
255
- ## More Information [optional]
256
 
257
  [More Information Needed]
258
 
259
  ## Model Card Authors [optional]
260
 
261
- [More Information Needed]
262
 
263
  ## Model Card Contact
264
 
265
- [More Information Needed]
 
17
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
18
 
19
  - **Developed by:** [Isaac Chung](https://huggingface.co/isaacchung)
20
+ <!-- - **Funded by [optional]:** [More Information Needed] -->
21
+ <!-- - **Shared by [optional]:** [More Information Needed] -->
22
+ <!-- - **Model type:** [More Information Needed] -->
23
  - **Language(s) (NLP):** [English]
24
  - **License:** [Apache 2.0]
25
  - **Finetuned from model [optional]:** [meta-llama/Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
26
 
27
+ <!-- ### Model Sources [optional] -->
28
 
29
  <!-- Provide the basic links for the model. -->
30
 
31
+ <!-- - **Repository:** [More Information Needed]
32
  - **Paper [optional]:** [More Information Needed]
33
+ - **Demo [optional]:** [More Information Needed] -->
34
 
35
+ <!-- ## Uses -->
36
 
37
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
38
 
39
+ <!-- ### Direct Use -->
40
 
41
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
42
 
43
+ <!-- [More Information Needed] -->
44
 
45
+ <!-- ### Downstream Use [optional] -->
46
 
47
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
48
 
49
+ <!-- [More Information Needed] -->
50
 
51
+ <!-- ### Out-of-Scope Use -->
52
 
53
  <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
54
 
55
+ <!-- [More Information Needed] -->
56
 
57
+ <!-- ## Bias, Risks, and Limitations -->
58
 
59
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
60
 
61
+ <!-- [More Information Needed] -->
62
 
63
+ <!-- ### Recommendations -->
64
 
65
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
66
 
67
+ <!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. -->
68
 
69
  ## How to Get Started with the Model
70
 
 
77
  model = AutoModelForCausalLM.from_pretrained("isaacchung/llama3-8B-hotpotqa")
78
  ```
79
 
80
+ <!-- [More Information Needed] -->
81
 
82
  ## Training Details
83
 
 
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
  https://huggingface.co/datasets/isaacchung/hotpotqa-dev-raft-subset
88
 
89
+ <!-- [More Information Needed] -->
90
 
91
  ### Training Procedure
92
 
93
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
 
95
+ <!-- #### Preprocessing [optional] -->
96
 
97
+ <!-- [More Information Needed] -->
98
 
99
 
100
  #### Training Hyperparameters
101
 
102
+ <!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> -->
103
 
104
  Model loaded:
105
  ```python
 
160
  )
161
  ```
162
 
163
+ <!-- #### Speeds, Sizes, Times [optional] -->
164
 
165
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
166
 
167
+ <!-- [More Information Needed] -->
168
 
169
+ <!-- ## Evaluation -->
170
 
171
  <!-- This section describes the evaluation protocols and provides the results. -->
172
 
173
+ <!-- ### Testing Data, Factors & Metrics -->
174
 
175
+ <!-- #### Testing Data -->
176
 
177
  <!-- This should link to a Dataset Card if possible. -->
178
 
179
+ <!-- [More Information Needed] -->
180
 
181
+ <!-- #### Factors -->
182
 
183
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
184
 
185
+ <!-- [More Information Needed] -->
186
 
187
+ <!-- #### Metrics -->
188
 
189
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
190
 
191
+ <!-- [More Information Needed] -->
192
 
193
+ <!-- ### Results -->
194
 
195
+ <!-- [More Information Needed] -->
196
 
197
+ <!-- #### Summary -->
198
 
199
 
200
 
201
+ <!-- ## Model Examination [optional] -->
202
 
203
  <!-- Relevant interpretability work for the model goes here -->
204
 
205
+ <!-- [More Information Needed] -->
206
 
207
+ <!-- ## Environmental Impact -->
208
 
209
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
210
+ <!--
211
  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).
212
 
213
  - **Hardware Type:** [More Information Needed]
 
229
  #### Hardware
230
 
231
  [More Information Needed]
232
+ -->
233
+ <!-- #### Software
234
 
235
  [More Information Needed]
236
 
 
238
 
239
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
240
 
241
+ <!-- **BibTeX:**
242
 
243
  [More Information Needed]
244
 
 
246
 
247
  [More Information Needed]
248
 
249
+ ## Glossary [optional] -->
250
 
251
  <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
252
 
253
+ <!-- [More Information Needed] -->
254
 
255
+ <!-- ## More Information [optional]
256
 
257
  [More Information Needed]
258
 
259
  ## Model Card Authors [optional]
260
 
261
+ [More Information Needed] -->
262
 
263
  ## Model Card Contact
264
 
265
+ [Isaac Chung](https://huggingface.co/isaacchung)