shainaraza commited on
Commit
ca6f36f
·
verified ·
1 Parent(s): b2760e0

Add model description (DIA lab card)

Browse files
Files changed (1) hide show
  1. README.md +37 -186
README.md CHANGED
@@ -1,6 +1,10 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
4
  dia_version: '0.1'
5
  dia_report:
6
  scope: incremental
@@ -31,199 +35,46 @@ dia_report:
31
  - 1.8
32
  - 4.0
33
  tool: codecarbon
 
 
 
34
  ---
35
 
36
- # Model Card for Model ID
37
 
38
- <!-- Provide a quick summary of what the model is/does. -->
 
 
39
 
 
 
 
40
 
 
41
 
42
- ## Model Details
43
 
44
- ### Model Description
 
 
 
 
 
 
 
45
 
46
- <!-- Provide a longer summary of what this model is. -->
 
 
47
 
48
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
49
 
50
- - **Developed by:** [More Information Needed]
51
- - **Funded by [optional]:** [More Information Needed]
52
- - **Shared by [optional]:** [More Information Needed]
53
- - **Model type:** [More Information Needed]
54
- - **Language(s) (NLP):** [More Information Needed]
55
- - **License:** [More Information Needed]
56
- - **Finetuned from model [optional]:** [More Information Needed]
57
 
58
- ### Model Sources [optional]
59
 
60
- <!-- Provide the basic links for the model. -->
61
-
62
- - **Repository:** [More Information Needed]
63
- - **Paper [optional]:** [More Information Needed]
64
- - **Demo [optional]:** [More Information Needed]
65
-
66
- ## Uses
67
-
68
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
69
-
70
- ### Direct Use
71
-
72
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
73
-
74
- [More Information Needed]
75
-
76
- ### Downstream Use [optional]
77
-
78
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
79
-
80
- [More Information Needed]
81
-
82
- ### Out-of-Scope Use
83
-
84
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
85
-
86
- [More Information Needed]
87
-
88
- ## Bias, Risks, and Limitations
89
-
90
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
91
-
92
- [More Information Needed]
93
-
94
- ### Recommendations
95
-
96
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
97
-
98
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
99
-
100
- ## How to Get Started with the Model
101
-
102
- Use the code below to get started with the model.
103
-
104
- [More Information Needed]
105
-
106
- ## Training Details
107
-
108
- ### Training Data
109
-
110
- <!-- 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. -->
111
-
112
- [More Information Needed]
113
-
114
- ### Training Procedure
115
-
116
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
117
-
118
- #### Preprocessing [optional]
119
-
120
- [More Information Needed]
121
-
122
-
123
- #### Training Hyperparameters
124
-
125
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
126
-
127
- #### Speeds, Sizes, Times [optional]
128
-
129
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
130
-
131
- [More Information Needed]
132
-
133
- ## Evaluation
134
-
135
- <!-- This section describes the evaluation protocols and provides the results. -->
136
-
137
- ### Testing Data, Factors & Metrics
138
-
139
- #### Testing Data
140
-
141
- <!-- This should link to a Dataset Card if possible. -->
142
-
143
- [More Information Needed]
144
-
145
- #### Factors
146
-
147
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
148
-
149
- [More Information Needed]
150
-
151
- #### Metrics
152
-
153
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
154
-
155
- [More Information Needed]
156
-
157
- ### Results
158
-
159
- [More Information Needed]
160
-
161
- #### Summary
162
-
163
-
164
-
165
- ## Model Examination [optional]
166
-
167
- <!-- Relevant interpretability work for the model goes here -->
168
-
169
- [More Information Needed]
170
-
171
- ## Environmental Impact
172
-
173
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
174
-
175
- 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).
176
-
177
- - **Hardware Type:** [More Information Needed]
178
- - **Hours used:** [More Information Needed]
179
- - **Cloud Provider:** [More Information Needed]
180
- - **Compute Region:** [More Information Needed]
181
- - **Carbon Emitted:** [More Information Needed]
182
-
183
- ## Technical Specifications [optional]
184
-
185
- ### Model Architecture and Objective
186
-
187
- [More Information Needed]
188
-
189
- ### Compute Infrastructure
190
-
191
- [More Information Needed]
192
-
193
- #### Hardware
194
-
195
- [More Information Needed]
196
-
197
- #### Software
198
-
199
- [More Information Needed]
200
-
201
- ## Citation [optional]
202
-
203
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
204
-
205
- **BibTeX:**
206
-
207
- [More Information Needed]
208
-
209
- **APA:**
210
-
211
- [More Information Needed]
212
-
213
- ## Glossary [optional]
214
-
215
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
216
-
217
- [More Information Needed]
218
-
219
- ## More Information [optional]
220
-
221
- [More Information Needed]
222
-
223
- ## Model Card Authors [optional]
224
-
225
- [More Information Needed]
226
-
227
- ## Model Card Contact
228
-
229
- [More Information Needed]
 
1
  ---
2
+ library_name: peft
3
+ tags:
4
+ - dia
5
+ - carbon-footprint
6
+ - energy-efficiency
7
+ - sustainability
8
  dia_version: '0.1'
9
  dia_report:
10
  scope: incremental
 
35
  - 1.8
36
  - 4.0
37
  tool: codecarbon
38
+ license: apache-2.0
39
+ pipeline_tag: text-generation
40
+ base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
41
  ---
42
 
43
+ # TinyLlama 1.1B Chat LoRA (CPU (80-core))
44
 
45
+ A demo model from the **Data & Impact Accounting (DIA)** lab. It performs
46
+ instruction-tuning (LoRA adapter) via **LoRA (PEFT)**, with the base model `TinyLlama/TinyLlama-1.1B-Chat-v1.0`, trained on
47
+ **CPU (80-core)**.
48
 
49
+ The point of this repo is not the model itself but its **`dia_report`** — a
50
+ standardized record of the energy, carbon, and water used to train it, embedded
51
+ in this card's metadata.
52
 
53
+ This footprint feeds the DIA dashboard, which rolls up a base model and all its derivatives to show the **cumulative** carbon, water, and energy cost of a model family.
54
 
55
+ ## Training footprint
56
 
57
+ | Metric | Value |
58
+ |---|---|
59
+ | Hardware | 1× cpu-80core |
60
+ | Compute | 1.0613 GPU-hours |
61
+ | Energy | 0.0515 (measured) kWh |
62
+ | Carbon | 0.0033 (measured) kgCO₂eq |
63
+ | Water | 0.093–0.206 (estimated-from-default-wue) L |
64
+ | Grid region | ca-on |
65
 
66
+ *Energy and carbon are measured with [CodeCarbon](https://github.com/mlco2/codecarbon);
67
+ water is estimated from a default water-usage-effectiveness range. Carbon uses the
68
+ local grid's intensity (Ontario, ~0.03 kgCO₂eq/kWh).*
69
 
70
+ ## Reproduce
71
 
72
+ ```bash
73
+ REPO=DIA-MVP/tinyllama-lora-cpu python scripts/train_llama_lora.py
74
+ ```
 
 
 
 
75
 
76
+ ## Links
77
 
78
+ - **Footprint table (dataset):** [DIA-MVP/dia-state-lab-2026](https://huggingface.co/datasets/DIA-MVP/dia-state-lab-2026)
79
+ - **Project / paper:** [ai-impact-accounting](https://github.com/VectorInstitute/ai-impact-accounting)
80
+ - **Lab workflow:** see `LAB.md` in the repo