JSR-0003 commited on
Commit
9442bca
·
verified ·
1 Parent(s): c70c81f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +213 -1
README.md CHANGED
@@ -67,4 +67,216 @@ base_model:
67
  - unsloth/Llama-4-Scout-17B-16E-Instruct-GGUF
68
  - meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8
69
  - meta-llama/Llama-4-Scout-17B-16E
70
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
67
  - unsloth/Llama-4-Scout-17B-16E-Instruct-GGUF
68
  - meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8
69
  - meta-llama/Llama-4-Scout-17B-16E
70
+ metrics:
71
+ - accuracy
72
+ - f1
73
+ - exact_match
74
+ - bleu
75
+ - code_eval
76
+ library_name: transformers
77
+ tags:
78
+ - Llama-4
79
+ - transformer
80
+ - text-generation
81
+ - code-generation
82
+ - c++
83
+ - computer-science
84
+ - educational
85
+ - visual-studio
86
+ - open-source
87
+ - student-assistant
88
+ ---
89
+ # Model Card for Model ID
90
+
91
+ <!-- Provide a quick summary of what the model is/does. -->
92
+
93
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
94
+
95
+ ## Model Details
96
+
97
+ ### Model Description
98
+
99
+ <!-- Provide a longer summary of what this model is. -->
100
+
101
+
102
+
103
+ - **Developed by:** [More Information Needed]
104
+ - **Funded by [optional]:** [More Information Needed]
105
+ - **Shared by [optional]:** [More Information Needed]
106
+ - **Model type:** [More Information Needed]
107
+ - **Language(s) (NLP):** [More Information Needed]
108
+ - **License:** [More Information Needed]
109
+ - **Finetuned from model [optional]:** [More Information Needed]
110
+
111
+ ### Model Sources [optional]
112
+
113
+ <!-- Provide the basic links for the model. -->
114
+
115
+ - **Repository:** [More Information Needed]
116
+ - **Paper [optional]:** [More Information Needed]
117
+ - **Demo [optional]:** [More Information Needed]
118
+
119
+ ## Uses
120
+
121
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
122
+
123
+ ### Direct Use
124
+
125
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
126
+
127
+ [More Information Needed]
128
+
129
+ ### Downstream Use [optional]
130
+
131
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
132
+
133
+ [More Information Needed]
134
+
135
+ ### Out-of-Scope Use
136
+
137
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
138
+
139
+ [More Information Needed]
140
+
141
+ ## Bias, Risks, and Limitations
142
+
143
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
144
+
145
+ [More Information Needed]
146
+
147
+ ### Recommendations
148
+
149
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
150
+
151
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
152
+
153
+ ## How to Get Started with the Model
154
+
155
+ Use the code below to get started with the model.
156
+
157
+ [More Information Needed]
158
+
159
+ ## Training Details
160
+
161
+ ### Training Data
162
+
163
+ <!-- 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. -->
164
+
165
+ [More Information Needed]
166
+
167
+ ### Training Procedure
168
+
169
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
170
+
171
+ #### Preprocessing [optional]
172
+
173
+ [More Information Needed]
174
+
175
+
176
+ #### Training Hyperparameters
177
+
178
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
179
+
180
+ #### Speeds, Sizes, Times [optional]
181
+
182
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
183
+
184
+ [More Information Needed]
185
+
186
+ ## Evaluation
187
+
188
+ <!-- This section describes the evaluation protocols and provides the results. -->
189
+
190
+ ### Testing Data, Factors & Metrics
191
+
192
+ #### Testing Data
193
+
194
+ <!-- This should link to a Dataset Card if possible. -->
195
+
196
+ [More Information Needed]
197
+
198
+ #### Factors
199
+
200
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
201
+
202
+ [More Information Needed]
203
+
204
+ #### Metrics
205
+
206
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
207
+
208
+ [More Information Needed]
209
+
210
+ ### Results
211
+
212
+ [More Information Needed]
213
+
214
+ #### Summary
215
+
216
+
217
+
218
+ ## Model Examination [optional]
219
+
220
+ <!-- Relevant interpretability work for the model goes here -->
221
+
222
+ [More Information Needed]
223
+
224
+ ## Environmental Impact
225
+
226
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
227
+
228
+ 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).
229
+
230
+ - **Hardware Type:** [More Information Needed]
231
+ - **Hours used:** [More Information Needed]
232
+ - **Cloud Provider:** [More Information Needed]
233
+ - **Compute Region:** [More Information Needed]
234
+ - **Carbon Emitted:** [More Information Needed]
235
+
236
+ ## Technical Specifications [optional]
237
+
238
+ ### Model Architecture and Objective
239
+
240
+ [More Information Needed]
241
+
242
+ ### Compute Infrastructure
243
+
244
+ [More Information Needed]
245
+
246
+ #### Hardware
247
+
248
+ [More Information Needed]
249
+
250
+ #### Software
251
+
252
+ [More Information Needed]
253
+
254
+ ## Citation [optional]
255
+
256
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
257
+
258
+ **BibTeX:**
259
+
260
+ [More Information Needed]
261
+
262
+ **APA:**
263
+
264
+ [More Information Needed]
265
+
266
+ ## Glossary [optional]
267
+
268
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
269
+
270
+ [More Information Needed]
271
+
272
+ ## More Information [optional]
273
+
274
+ [More Information Needed]
275
+
276
+ ## Model Card Authors [optional]
277
+
278
+ [More Information Needed]
279
+
280
+ ## Model Card Contact
281
+
282
+ [More Information Needed]