oopere commited on
Commit
60f2601
·
verified ·
1 Parent(s): c17df26

Add model card

Browse files
Files changed (1) hide show
  1. README.md +147 -164
README.md CHANGED
@@ -1,199 +1,182 @@
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
128
-
129
- [More Information Needed]
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
 
155
- ### Model Architecture and Objective
156
 
157
- [More Information Needed]
 
 
 
 
 
 
 
158
 
159
- ### Compute Infrastructure
160
 
161
- [More Information Needed]
 
 
162
 
163
- #### Hardware
164
 
165
- [More Information Needed]
166
 
167
- #### Software
 
 
 
168
 
169
- [More Information Needed]
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]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
 
 
 
198
 
199
- [More Information Needed]
 
1
  ---
2
+ language:
3
+ - en
4
+ tags:
5
+ - optipfair
6
+ - rearchitecting-llms
7
+ - knowledge-distillation
8
+ - depth-pruning
9
+ - model-optimization
10
+ - small-language-model
11
+ - gemma
12
+ - educational
13
+ license: apache-2.0
14
+ base_model: google/gemma-3-270m
15
+ metrics:
16
+ - perplexity
17
+ - accuracy
18
+ datasets:
19
+ - HuggingFaceTB/cosmopedia
20
  ---
21
 
22
+ # Qwen3.5-0.65B-Base-Rearchitected
23
 
24
+ ## Model Description
25
 
26
+ This model is a surgically optimized and distilled version of **Qwen3.5-0.5B-Base-Rearchitected**,
27
+ created with the techniques covered in **Chapter 6** in the book **"Rearchitecting LLMs"**.
28
 
29
+ * **Book:** [Rearchitecting LLMs](https://hubs.la/Q040tvtp0)
30
+ * **Framework:** [OptiPFair](https://github.com/peremartra/optipfair)
31
+ * **Technique:** Depth Pruning + Knowledge Distillation (Labels-Only with Skew KL Divergence)
32
+ * **Chapter:** Chapter 6 - Knowledge Recovery
33
 
34
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ## Performance & Retention Metrics
37
 
38
+ The goal of this optimization was to maximize parameter efficiency while maintaining the highest possible retention of the Teacher's capabilities.
39
 
40
+ ### Retention Summary (vs Teacher Baseline)
41
 
42
+ | Metric | Value | Description |
43
+ |:---|:---|:---|
44
+ | **PPL Retention** | 109.62% | Linguistic quality preserved (Teacher PPL / Student PPL × 100) |
45
+ | **Capabilities Retention** | 89.21% | Reasoning power retained across benchmarks (Avg Student / Avg Teacher × 100) |
46
+ | **Overall Retention** | 92.11% | Combined health score (average of PPL + Capabilities retention) |
47
 
48
+ ### Capability Benchmarks (LM Evaluation Harness)
49
 
50
+ **Recovery** = How much of the pruning degradation was recovered through distillation.
51
 
52
+ | Benchmark | Teacher | Pruned (No KD) | Student (After KD) | Recovery |
53
+ |:---|:---:|:---:|:---:|:---:|
54
+ | **Arc Easy** | 67.5% | 56.3% | 60.7% | 39.8% |
55
+ | **Winogrande** | 59.4% | 55.5% | 55.9% | 9.9% |
56
+ | **Hellaswag** | 54.9% | 44.0% | 47.2% | 29.6% |
57
+ | **Lambada Openai** | 50.9% | 8.4% | 39.9% | 74.1% |
58
+ | **Piqa** | 71.5% | 63.6% | 67.7% | 51.3% |
59
+ | **Average** | 60.8% | 45.5% | 54.3% | 57.1% |
60
 
61
+ ### Linguistic Quality
62
 
63
+ * **Final Perplexity (PPL):** 6.70
64
+ * **Teacher Baseline PPL:** 7.34
65
+ * **Pruned (No KD) PPL:** 24.29
66
 
67
+ ---
68
 
69
+ ## Architecture Details
70
 
71
+ * **Teacher Model:** `Qwen3.5-0.5B-Base-Rearchitected` (752,393,024 parameters)
72
+ * **Student Model:** Pruned to (666,171,584 parameters)
73
+ * **Layers Removed:** 4 layers (indices: [21, 20, 9, 22])
74
+ * **Parameter Reduction:** 11.46%
75
 
76
+ ---
77
 
78
+ ## Training Procedure
79
+
80
+ ### Dataset
81
+ * **Source:** [Cosmopedia-v2](https://huggingface.co/datasets/HuggingFaceTB/cosmopedia)
82
+ * **Samples:** 40,000 (balanced across 4 subsets: stories, wikihow, openstax, web_samples)
83
+ * **Train/Val Split:** 80% / 20%
84
+
85
+ ### Hyperparameters
86
+ * **Epochs:** 1
87
+ * **Batch Size:** 12 (effective: 48 with gradient accumulation)
88
+ * **Learning Rate:** 4e-05
89
+ * **Loss Function:** `α·CrossEntropy + β·Skew-KLD`
90
+ * Task Loss Weight (α): 0.5
91
+ * Logits Loss Weight (β): 0.5
92
+ * Skew Interpolation Factor: 0.0
93
+ * Temperature: 2.0
94
+ * **Optimizer:** AdamW
95
+ * **Gradient Clipping:** 1.0
96
+
97
+ ### Hardware & Training Time
98
+ * **GPU:** NVIDIA A100-SXM4-80GB
99
+ * **Training Time:** 4011.1s (66.85 minutes)
100
+ * **Avg Time per Epoch:** 4011.1s
101
 
102
+ ---
103
 
104
+ ## How to Use
105
+ ```python
106
+ from transformers import AutoModelForCausalLM, AutoTokenizer
107
+
108
+ # Load model and tokenizer
109
+ model_id = "oopere/Qwen3.5-0.65B-Base-Rearchitected"
110
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
111
+ model = AutoModelForCausalLM.from_pretrained(model_id)
112
+
113
+ # Generate text
114
+ prompt = "Paris is the capital of"
115
+ inputs = tokenizer(prompt, return_tensors="pt")
116
+ outputs = model.generate(
117
+ **inputs,
118
+ max_new_tokens=50,
119
+ do_sample=False,
120
+ num_beams=3
121
+ )
122
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
123
+ ```
124
 
125
+ ---
126
 
127
+ ## Limitations & Intended Use
128
 
129
+ ### Intended Use
130
+ This is an **educational model** created as part of the **Hands-on Lab in Chapter 6** of "Rearchitecting LLMs". It demonstrates:
131
+ - Surgical depth pruning using data-driven layer importance analysis
132
+ - Knowledge recovery through labels-only distillation with Skew KL Divergence
133
+ - The complete optimization pipeline: Prune → Distill → Evaluate
134
 
135
+ **Not intended for production use.** This model serves as a learning artifact and baseline for readers to improve upon.
136
 
137
+ ### Limitations
138
+ - **Training Data:** General-purpose Cosmopedia corpus (not domain-specialized)
139
+ - **Knowledge Coverage:** Reduced compared to full-scale models due to structural pruning
140
+ - **Capabilities:** Best suited for simple completion tasks; complex reasoning may be degraded
141
+ - **Language:** English only
142
 
143
+ ---
144
 
145
+ ## Citation
146
+
147
+ If you use this model or the techniques described in your research or projects, please cite:
148
+
149
+ ### Book
150
+ ```bibtex
151
+ @book{martra2026rearchitecting,
152
+ author = {Pere Martra},
153
+ title = {Rearchitecting LLMs: Structural techniques for efficient models},
154
+ publisher = {Manning Publications},
155
+ year = {2026},
156
+ url = {https://hubs.la/Q040tvtp0}
157
+ }
158
+ ```
159
+
160
+ ### Framework
161
+ ```bibtex
162
+ @software{optipfair2024,
163
+ author = {Pere Martra},
164
+ title = {OptiPFair: Structural Pruning and Bias Analysis for LLMs},
165
+ year = {2024},
166
+ url = {https://github.com/peremartra/optipfair}
167
+ }
168
+ ```
169
 
170
+ ---
171
 
172
+ ## Acknowledgments
173
 
174
+ This model was created following the methodologies taught in **"Rearchitecting LLMs"** (Manning Publications, 2026). Special thanks to the Manning editorial team and the open-source community behind Hugging Face Transformers and PyTorch.
175
 
176
+ **Challenge for readers:** Can you improve the retention metrics beyond 92.1%? Try adjusting:
177
+ - Layer selection strategy (use cosine similarity analysis)
178
+ - Distillation dataset (domain-specific data)
179
+ - Loss function weights (α, β, temperature)
180
+ - Training epochs and learning rate
181
 
182
+ Share your results in the [book's discussion forum](https://hubs.la/Q040tvtp0)!