EstebanBarac commited on
Commit
bdcdcb9
·
verified ·
1 Parent(s): 348921e

Add real model card (mérito Well-Tuned): QLoRA details, dataset, smoke test, usage

Browse files
Files changed (1) hide show
  1. README.md +127 -195
README.md CHANGED
@@ -1,199 +1,131 @@
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
+ base_model: Qwen/Qwen2.5-7B-Instruct
3
  library_name: transformers
4
+ license: apache-2.0
5
+ language:
6
+ - es
7
+ tags:
8
+ - qlora
9
+ - peft
10
+ - conversational
11
+ - education
12
+ - spanish
13
+ - build-small-hackathon
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ # Sofía Qwen2.5-7B-Instruct fine-tuneado para una compañera de voz de una nena de 3 años
18
+
19
+ **TL;DR (EN):** QLoRA fine-tune of `Qwen/Qwen2.5-7B-Instruct` (merged, full
20
+ precision weights) that teaches the base model to consistently play
21
+ "Sofía" — a warm, short-sentence Spanish-speaking companion for a ~3
22
+ year old — to present curated content (`<contenido>`) **verbatim**
23
+ instead of paraphrasing/inventing it, and to gently refuse/redirect
24
+ unsafe topics. Built for the
25
+ [Build Small Hackathon](https://huggingface.co/build-small-hackathon)
26
+ (track *Backyard AI*, mérito *Well-Tuned*). Powers the
27
+ [`sofia-educational-companion`](https://huggingface.co/spaces/build-small-hackathon/sofia-educational-companion)
28
+ Space.
29
+
30
+ ## Qué es
31
+
32
+ Este modelo es el "pegamento conversacional" de **Sofía**, una compañera
33
+ educativa por voz para una niña de ~3 años (proyecto Lumi, Build Small
34
+ Hackathon, track Backyard AI). El LLM **nunca** es la fuente de hechos:
35
+ todo el contenido (cuentos, actividades, números) vive curado en
36
+ `content/` y se le inyecta al modelo entre `<contenido>...</contenido>`.
37
+ Este fine-tune entrena **estilo y seguridad**, no conocimiento.
38
+
39
+ Objetivos del fine-tune:
40
+ - Mantener siempre la persona "Sofía": cálida, frases muy cortas,
41
+ español rioplatense, una pregunta por turno.
42
+ - Presentar el contenido curado **verbatim** (sin parafrasear ni
43
+ inventar), incluso cuando se le pide un cuento/actividad que no existe
44
+ en `content/`.
45
+ - Rechazar o redirigir con cariño temas no aptos para una niña de 3 años,
46
+ generalizando más allá de los términos exactos de
47
+ `safety/blocklist.txt` (defensa en profundidad).
48
+
49
+ ## Datos de entrenamiento
50
+
51
+ `finetune/build_dataset.py` genera `finetune/dataset.jsonl`: **196
52
+ ejemplos** en formato chat (mismo `SYSTEM_PROMPT` y los mismos bloques
53
+ `<contenido>`/`<nota>` que construye `llm/engine.py` en producción),
54
+ mezclando:
55
+
56
+ - saludos y charla / persona,
57
+ - entrega de actividades curadas (contar, formas, colores, animales),
58
+ x3 frases cada una,
59
+ - cambio de color de Sofía (intent `sofia_color`),
60
+ - cuentos curados,
61
+ - ~62 rechazos/redirecciones de temas no aptos que **no** repiten los
62
+ términos exactos de la blocklist.
63
+
64
+ ## Entrenamiento
65
+
66
+ QLoRA sobre `Qwen/Qwen2.5-7B-Instruct`, corrido en Modal (GPU A10G):
67
+
68
+ - Carga en 4-bit NF4 (`bnb_4bit_use_double_quant=True`), cómputo en bf16.
69
+ - LoRA `r=16`, `alpha=32`,
70
+ `target_modules=["q_proj", "k_proj", "v_proj", "o_proj"]`.
71
+ - 3 épocas, batch size 2, gradient accumulation 4, learning rate 2e-4.
72
+ - 72 steps, ~408s en A10G. Loss 2.51 → 0.14.
73
+ - El adapter se mergeó (`merge_and_unload`) y se publicó en este repo
74
+ como pesos completos en safetensors.
75
+
76
+ Código: `finetune/train_modal.py` y `finetune/merge_lora.py` en el
77
+ [repo del proyecto](https://huggingface.co/spaces/build-small-hackathon/sofia-educational-companion).
78
+
79
+ ## Evaluación (smoke test)
80
+
81
+ `finetune/smoke_test_modal.py` corrió 5 turnos representativos sobre este
82
+ modelo ya mergeado: saludo, entrega de `<contenido>` de conteo, una
83
+ pregunta sobre un arma, miedo a los monstruos, y un pedido de cuento
84
+ inventado ("un dragón que come autos"). Resultado: saluda en persona,
85
+ repite el `<contenido>` **verbatim** (a diferencia de alternativas
86
+ probadas como Nemotron-mini/Nemotron-3-nano, que parafraseaban o
87
+ inventaban), rechaza el tema del arma sin engancharse, redirige el miedo
88
+ con calidez, y ante el cuento inventado dice que no lo tiene y ofrece una
89
+ alternativa curada en vez de inventar una.
90
+
91
+ ## Cómo usarlo
92
+
93
+ ```python
94
+ import torch
95
+ from transformers import AutoModelForCausalLM, AutoTokenizer
96
+
97
+ MODEL_ID = "build-small-hackathon/sofia-qwen2.5-7b"
98
+
99
+ tokenizer = AutoTokenizer.from_pretrained(MODEL_ID)
100
+ model = AutoModelForCausalLM.from_pretrained(
101
+ MODEL_ID, torch_dtype=torch.bfloat16
102
+ ).to("cuda")
103
+
104
+ # SYSTEM_PROMPT exacto y bloques <contenido>/<nota>: ver llm/engine.py
105
+ messages = [
106
+ {"role": "system", "content": SYSTEM_PROMPT},
107
+ {"role": "user", "content": "Hola Sofía"},
108
+ ]
109
+ text = tokenizer.apply_chat_template(
110
+ messages, tokenize=False, add_generation_prompt=True
111
+ )
112
+ inputs = tokenizer(text, return_tensors="pt").to("cuda")
113
+ output = model.generate(
114
+ **inputs, max_new_tokens=120, do_sample=True, temperature=0.6
115
+ )
116
+ ```
117
+
118
+ ## Limitaciones
119
+
120
+ - Entrenado para **un caso de uso muy acotado**: compañera de juego para
121
+ una niña de 3 años, en español rioplatense, con contenido inyectado
122
+ por el sistema (`<contenido>`/`<nota>`/`<contexto>`). Fuera de ese
123
+ contexto se comporta básicamente como el Qwen2.5-7B-Instruct base.
124
+ - No agrega conocimiento factual nuevo: por diseño, los hechos siguen
125
+ viviendo en `content/`, nunca en los pesos.
126
+ - Dataset chico (196 ejemplos), curado a mano para un hackathon — no es
127
+ un benchmark de seguridad general.
128
+
129
+ ## Licencia
130
+
131
+ Apache 2.0, igual que el modelo base `Qwen/Qwen2.5-7B-Instruct`.