guell00 commited on
Commit
e098616
Β·
verified Β·
1 Parent(s): 799b10a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +208 -208
README.md CHANGED
@@ -3,8 +3,10 @@ license: mit
3
  language:
4
  - pt
5
  - en
 
 
6
  base_model:
7
- - AtomicChat/Ornith-1.5-9B-GGUF
8
  tags:
9
  - coder
10
  - code
@@ -13,146 +15,144 @@ tags:
13
  - fast
14
  - smart
15
  ---
16
-
17
  <div align="center">
18
 
19
-
20
  ![image](https://cdn-uploads.huggingface.co/production/uploads/644afe169279988e0cbcd2d9/jCFCVTpFLOvaCUOF90b9o.png)
21
 
22
  <br>
23
 
24
  # LEVUM
25
 
26
- [πŸ‘‰ Acesse a Landing Page do Velum AI](https://guell11.github.io/velum-ai/)
27
 
28
- ### Local Β· CΓ³digo Β· Software
29
 
30
- **Um modelo local baseado em Qwen 3.5 9B, direcionado para desenvolvimento de software.**
31
 
32
- Escrever. Entender. Corrigir. Refatorar. Construir.
33
 
34
- **Menos cerimΓ΄nia. Mais cΓ³digo rodando.**
35
 
36
  </div>
37
 
38
  ---
39
 
40
- ## Sobre
41
 
42
- **LEVUM** Γ© um modelo de **9 bilhΓ΅es de parΓ’metros**, baseado em **Qwen 3.5 9B** e direcionado para tarefas de desenvolvimento de software.
43
 
44
- O objetivo Γ© simples: trabalhar perto do projeto e transformar instruΓ§Γ΅es em cΓ³digo ΓΊtil.
45
 
46
- O modelo foi pensado para tarefas como:
47
 
48
- * geraΓ§Γ£o de cΓ³digo;
49
- * implementaΓ§Γ£o de features;
50
  * debugging;
51
- * refatoraΓ§Γ£o;
52
- * explicaΓ§Γ£o e leitura de cΓ³digo;
53
- * criaΓ§Γ£o de protΓ³tipos;
54
- * estruturaΓ§Γ£o de projetos;
55
- * geraΓ§Γ£o de aplicaΓ§Γ΅es completas;
56
- * assistΓͺncia durante desenvolvimento local.
57
 
58
- LEVUM segue uma filosofia **local-first**: o modelo pode rodar prΓ³ximo da IDE, dos arquivos e do contexto real do projeto, dependendo do runtime e da quantizaΓ§Γ£o escolhidos.
59
 
60
- > **Software primeiro. Local por padrΓ£o.**
61
 
62
  ---
63
 
64
- ## EspecificaΓ§Γ΅es
65
 
66
- | | |
67
- | ----------------- | -------------------------------------------- |
68
- | **Modelo** | LEVUM |
69
- | **Base** | Qwen 3.5 9B |
70
- | **ParΓ’metros** | 9B |
71
- | **Foco** | CΓ³digo / Software |
72
- | **Uso principal** | Desenvolvimento de software |
73
- | **ExecuΓ§Γ£o** | Local |
74
- | **Idioma** | PortuguΓͺs + capacidades multilΓ­ngues da base |
75
- | **Origem** | πŸ‡§πŸ‡· Brasil |
76
 
77
  ---
78
 
79
- # QuantizaΓ§Γ΅es
80
 
81
- LEVUM Γ© disponibilizado em diferentes nΓ­veis de quantizaΓ§Γ£o para permitir execuΓ§Γ£o em uma variedade maior de hardware.
82
 
83
- A escolha ideal depende principalmente de:
84
 
85
- **RAM / VRAM β†’ velocidade β†’ fidelidade**
86
 
87
- ComparaΓ§Γ£o da qualidade relativa do modelo apΓ³s diferentes nΓ­veis de quantizaΓ§Γ£o:
88
 
89
  ![image](https://cdn-uploads.huggingface.co/production/uploads/644afe169279988e0cbcd2d9/Kqx6ACbFDrb_UG0Zmah4z.png)
90
 
91
- Valores definidos: Q8 = 99%, Q4 = 50%, Q3 = 30%, Q2 = 25% e Q1 = 10%.
92
 
93
- ### Q8 β€” Fidelidade
94
 
95
- Para mΓ‘quinas com memΓ³ria suficiente e usuΓ‘rios que querem preservar o mΓ‘ximo possΓ­vel da qualidade do modelo.
96
 
97
  `Q8_0`
98
 
99
  ---
100
 
101
- ### Q4 / IQ4 β€” EquilΓ­brio
102
 
103
- O ponto recomendado para muitos sistemas locais.
104
 
105
- Boa relaΓ§Γ£o entre tamanho, consumo de memΓ³ria e qualidade.
106
 
107
  `Q4_K_M` Β· `Q4_K_S` Β· `IQ4_XS` Β· `IQ4_NL` Β· `Q4_1` Β· `Q4_0`
108
 
109
  ---
110
 
111
- ### Q3 / IQ3 β€” Compacto
112
 
113
- Para hardware mais limitado ou situaΓ§Γ΅es onde reduzir RAM/VRAM Γ© prioridade.
114
 
115
  `Q3_K_L` Β· `Q3_K_M` Β· `Q3_K_S` Β· `IQ3_M` Β· `IQ3_S` Β· `IQ3_XS` Β· `IQ3_XXS`
116
 
117
  ---
118
 
119
- ### Q2 / IQ2 β€” Ultracompacto
120
 
121
- CompressΓ£o agressiva para ambientes onde versΓ΅es maiores simplesmente nΓ£o cabem.
122
 
123
  `Q2_K` Β· `Q2_K_S` Β· `IQ2_M` Β· `IQ2_S` Β· `IQ2_XS` Β· `IQ2_XXS` Β· `Q2_0` Β· `TQ2_0`
124
 
125
  ---
126
 
127
- ### IQ1 β€” MΓ­nimo
128
 
129
- A opΓ§Γ£o extrema.
130
 
131
  `IQ1_M`
132
 
133
- Indicada apenas quando economia de memΓ³ria Γ© mais importante do que preservar a fidelidade mΓ‘xima do modelo.
134
 
135
  ---
136
 
137
- > **Regra prΓ‘tica:** comece com `Q4_K_M`.
138
- > Se houver memΓ³ria sobrando, experimente `Q8_0`.
139
- > Se faltar memΓ³ria, desΓ§a para Q3, Q2 ou IQ1.
140
 
141
  ---
142
 
143
- # Executando localmente
144
 
145
  ## llama.cpp
146
 
147
- Baixe uma das versΓ΅es GGUF do LEVUM e execute com um runtime compatΓ­vel com GGUF.
148
 
149
  ```bash
150
  llama-cli \
151
  -m ./LEVUM-Q4_K_M.gguf \
152
- -p "Crie uma API REST em Python usando FastAPI."
153
  ```
154
 
155
- Para iniciar um servidor local:
156
 
157
  ```bash
158
  llama-server \
@@ -160,13 +160,13 @@ llama-server \
160
  -c 8192
161
  ```
162
 
163
- Depois disso, o modelo pode ser integrado a ferramentas locais que suportem endpoints compatΓ­veis.
164
 
165
  ---
166
 
167
  ## Ollama
168
 
169
- Crie um `Modelfile` apontando para o GGUF:
170
 
171
  ```dockerfile
172
  FROM ./LEVUM-Q4_K_M.gguf
@@ -175,68 +175,68 @@ PARAMETER temperature 0.6
175
  PARAMETER top_p 0.9
176
  ```
177
 
178
- Depois:
179
 
180
  ```bash
181
  ollama create levum -f Modelfile
182
  ollama run levum
183
  ```
184
 
185
- Exemplo:
186
 
187
  ```text
188
- >>> Crie uma API em FastAPI para gerenciar projetos e tarefas.
189
  ```
190
 
191
  ---
192
 
193
  ## LM Studio
194
 
195
- 1. Baixe uma quantizaΓ§Γ£o GGUF do LEVUM.
196
- 2. Importe o arquivo no LM Studio.
197
- 3. Carregue o modelo.
198
- 4. Ajuste o contexto de acordo com a memΓ³ria disponΓ­vel.
199
- 5. Inicie uma conversa ou o servidor local.
200
 
201
- Nenhuma infraestrutura remota Γ© necessΓ‘ria para a inferΓͺncia quando o modelo estΓ‘ sendo executado localmente.
202
 
203
  ---
204
 
205
  # Prompts
206
 
207
- LEVUM funciona melhor quando a tarefa, o contexto e o formato esperado sΓ£o explΓ­citos.
208
 
209
- ## Gerar um projeto
210
 
211
  ```text
212
- Crie um dashboard financeiro interativo em um ΓΊnico arquivo HTML.
213
 
214
- Requisitos:
215
- - HTML, CSS e JavaScript no mesmo arquivo
216
- - grΓ‘ficos interativos
217
- - responsivo
218
- - dados de exemplo
219
- - sem dependΓͺncias externas obrigatΓ³rias
220
 
221
- Retorne somente o HTML completo.
222
  ```
223
 
224
  ---
225
 
226
- ## Implementar uma feature
227
 
228
  ```text
229
- Analise o cΓ³digo abaixo e implemente autenticaΓ§Γ£o JWT.
230
 
231
- Requisitos:
232
- - preserve a arquitetura atual
233
- - valide tokens expirados
234
- - adicione middleware de autenticaΓ§Γ£o
235
- - nΓ£o altere endpoints pΓΊblicos
236
- - explique apenas decisΓ΅es importantes
237
 
238
- CΓ³digo:
239
- [cole o cΓ³digo aqui]
240
  ```
241
 
242
  ---
@@ -244,147 +244,147 @@ CΓ³digo:
244
  ## Debug
245
 
246
  ```text
247
- Encontre a causa do bug no cΓ³digo abaixo.
248
 
249
- Comportamento esperado:
250
- [descreva]
251
 
252
- Comportamento atual:
253
- [descreva]
254
 
255
- Erro:
256
- [cole o erro]
257
 
258
- CΓ³digo:
259
- [cole o cΓ³digo]
260
 
261
- Identifique a causa e retorne a correΓ§Γ£o completa.
262
  ```
263
 
264
  ---
265
 
266
- ## RefatoraΓ§Γ£o
267
 
268
  ```text
269
- Refatore este cΓ³digo.
270
 
271
- Objetivos:
272
- - reduzir duplicaΓ§Γ£o
273
- - melhorar legibilidade
274
- - manter comportamento atual
275
- - preservar a API pΓΊblica
276
- - evitar abstraΓ§Γ΅es desnecessΓ‘rias
277
 
278
- Retorne primeiro o cΓ³digo refatorado e depois um resumo curto das mudanΓ§as.
279
  ```
280
 
281
  ---
282
 
283
- # Formato de prompt
284
 
285
- Para tarefas maiores, uma estrutura simples costuma produzir resultados mais previsΓ­veis:
286
 
287
  ```text
288
- OBJETIVO
289
- O que precisa ser construΓ­do.
290
 
291
- CONTEXTO
292
- Stack, arquivos existentes e arquitetura.
293
 
294
- REQUISITOS
295
- Comportamentos obrigatΓ³rios.
296
 
297
- RESTRIÇÕES
298
- O que nΓ£o deve ser alterado.
299
 
300
- SAÍDA
301
- Formato exato esperado.
302
  ```
303
 
304
- Por exemplo:
305
 
306
  ```text
307
- OBJETIVO
308
- Criar uma pΓ‘gina de analytics.
309
 
310
- CONTEXTO
311
- Projeto React + TypeScript + Tailwind.
312
 
313
- REQUISITOS
314
- - grΓ‘fico de receita
315
- - filtros por perΓ­odo
316
- - cards de mΓ©tricas
317
- - tabela de transaΓ§Γ΅es
318
 
319
- RESTRIÇÕES
320
- - nΓ£o adicionar novas dependΓͺncias
321
- - reutilizar componentes existentes
322
 
323
- SAÍDA
324
- Retorne os arquivos completos que precisam ser criados ou alterados.
325
  ```
326
 
327
  ---
328
 
329
  # Code-first
330
 
331
- LEVUM foi pensado para trabalhar dentro do ciclo normal de desenvolvimento:
332
 
333
  ```text
334
- PROMPT / CΓ“DIGO
335
  ↓
336
  LEVUM
337
  ↓
338
- ENTENDER
339
  ↓
340
- GERAR
341
  ↓
342
  DEBUG
343
  ↓
344
- REFATORAR
345
  ↓
346
- SOFTWARE RODANDO
347
  ```
348
 
349
- ### GeraΓ§Γ£o
350
 
351
- Projetos, componentes, APIs, scripts e features.
352
 
353
  ### Debug
354
 
355
- AnΓ‘lise de erros, comportamento inesperado e correΓ§Γ΅es.
356
 
357
- ### RefatoraΓ§Γ£o
358
 
359
- Estrutura, legibilidade e manutenΓ§Γ£o de cΓ³digo existente.
360
 
361
- ### Prototipagem
362
 
363
- Transformar uma ideia em algo executΓ‘vel rapidamente.
364
 
365
  ---
366
 
367
- # Exemplo
368
 
369
  **Prompt**
370
 
371
  ```text
372
- Crie um jogo estilo Flappy Bird em um ΓΊnico HTML.
373
 
374
- Use apenas HTML, CSS e JavaScript.
375
 
376
- Inclua:
377
- - fΓ­sica
378
- - obstΓ‘culos
379
- - colisΓ£o
380
- - pontuaΓ§Γ£o
381
- - reinΓ­cio
382
- - controles por teclado e clique
383
 
384
- Retorne somente o HTML completo.
385
  ```
386
 
387
- **Resultado esperado**
388
 
389
  ```text
390
  prompt
@@ -395,109 +395,109 @@ HTML + CSS + JavaScript
395
  ↓
396
  browser
397
  ↓
398
- software rodando
399
  ```
400
 
401
  ---
402
 
403
  # Hardware
404
 
405
- O consumo real depende de vΓ‘rios fatores, incluindo:
406
 
407
- * quantizaΓ§Γ£o;
408
- * tamanho do contexto;
409
  * runtime;
410
  * KV cache;
411
  * CPU;
412
  * GPU;
413
- * quantidade de camadas descarregadas para GPU;
414
- * configuraΓ§Γ£o de inferΓͺncia.
415
 
416
- Por isso, os nΓΊmeros de memΓ³ria podem variar significativamente entre sistemas.
417
 
418
- Como regra geral:
419
 
420
  ```text
421
- mais bits
422
  ↑
423
- mais fidelidade
424
  ↑
425
- mais memΓ³ria
426
 
427
- menos bits
428
  ↓
429
- menos memΓ³ria
430
  ↓
431
- maior compressΓ£o
432
  ```
433
 
434
- Escolha a quantizaΓ§Γ£o com base no hardware disponΓ­vel e na qualidade necessΓ‘ria para a tarefa.
435
 
436
  ---
437
 
438
- # LimitaΓ§Γ΅es
439
 
440
- LEVUM continua sendo um modelo de linguagem.
441
 
442
- Isso significa que ele pode:
443
 
444
- * gerar cΓ³digo incorreto;
445
- * inventar APIs ou bibliotecas;
446
- * produzir soluΓ§Γ΅es inseguras;
447
- * interpretar requisitos de forma errada;
448
- * introduzir regressΓ΅es;
449
- * sugerir dependΓͺncias inexistentes;
450
- * gerar cΓ³digo que parece correto sem realmente funcionar.
451
 
452
- Para software importante, revise, teste e valide o cΓ³digo antes de colocΓ‘-lo em produΓ§Γ£o.
453
 
454
- CΓ³digo gerado por IA nΓ£o ganha poderes mΓ‘gicos sΓ³ porque compilou uma vez.
455
 
456
  ---
457
 
458
- # Uso responsΓ‘vel
459
 
460
- Antes de executar cΓ³digo gerado pelo modelo:
461
 
462
- 1. revise as alteraΓ§Γ΅es;
463
- 2. verifique dependΓͺncias;
464
- 3. execute testes;
465
- 4. valide entradas externas;
466
- 5. revise operaΓ§Γ΅es de filesystem, rede e banco de dados;
467
- 6. nΓ£o exponha segredos ou credenciais desnecessariamente;
468
- 7. use ambientes isolados quando estiver testando cΓ³digo desconhecido.
469
 
470
- Para aplicaΓ§Γ΅es crΓ­ticas, o modelo deve funcionar como ferramenta de assistΓͺncia, nΓ£o como ΓΊnica camada de revisΓ£o.
471
 
472
  ---
473
 
474
- # Modelo base
475
 
476
- LEVUM Γ© baseado em:
477
 
478
  **Qwen 3.5 9B**
479
 
480
- O modelo base fornece a capacidade geral sobre a qual o LEVUM Γ© construΓ­do.
481
 
482
- Consulte tambΓ©m o model card e a licenΓ§a do modelo base antes de distribuir ou utilizar derivados.
483
 
484
  ---
485
 
486
- # LicenΓ§a
487
 
488
- O uso do LEVUM estΓ‘ sujeito Γ  licenΓ§a publicada neste repositΓ³rio e, quando aplicΓ‘vel, aos termos e condiΓ§Γ΅es associados ao modelo base.
489
 
490
- Consulte o arquivo `LICENSE` antes de uso comercial, redistribuiΓ§Γ£o ou criaΓ§Γ£o de derivados.
491
 
492
  ---
493
 
494
- # Brasil
495
 
496
  <div align="center">
497
 
498
- ### πŸ‡§πŸ‡· FEITO NO BRASIL
499
 
500
- **InteligΓͺncia que fica por perto.**
501
 
502
  Local-first Β· Code-first Β· Software-first
503
 
@@ -509,4 +509,4 @@ Local-first Β· Code-first Β· Software-first
509
 
510
  **LEVUM Β© 2026**
511
 
512
- </div>
 
3
  language:
4
  - pt
5
  - en
6
+ - es
7
+ - fr
8
  base_model:
9
+ - ornith-ai/Ornith-1.5-9B
10
  tags:
11
  - coder
12
  - code
 
15
  - fast
16
  - smart
17
  ---
 
18
  <div align="center">
19
 
 
20
  ![image](https://cdn-uploads.huggingface.co/production/uploads/644afe169279988e0cbcd2d9/jCFCVTpFLOvaCUOF90b9o.png)
21
 
22
  <br>
23
 
24
  # LEVUM
25
 
26
+ [πŸ‘‰ Visit the Velum AI Landing Page](https://guell11.github.io/velum-ai/)
27
 
28
+ ### Local Β· Code Β· Software
29
 
30
+ **A local model based on Qwen 3.5 9B, focused on software development.**
31
 
32
+ Write. Understand. Fix. Refactor. Build.
33
 
34
+ **Less ceremony. More working code.**
35
 
36
  </div>
37
 
38
  ---
39
 
40
+ ## About
41
 
42
+ **LEVUM** is a **9-billion-parameter model**, based on **Qwen 3.5 9B** and focused on software development tasks.
43
 
44
+ The goal is simple: work close to the project and turn instructions into useful code.
45
 
46
+ The model was designed for tasks such as:
47
 
48
+ * code generation;
49
+ * feature implementation;
50
  * debugging;
51
+ * refactoring;
52
+ * code explanation and understanding;
53
+ * prototype creation;
54
+ * project structuring;
55
+ * complete application generation;
56
+ * assistance during local development.
57
 
58
+ LEVUM follows a **local-first** philosophy: the model can run close to the IDE, files, and the actual project context, depending on the chosen runtime and quantization.
59
 
60
+ > **Software first. Local by default.**
61
 
62
  ---
63
 
64
+ ## Specifications
65
 
66
+ | | |
67
+ | --------------- | ----------------------------------------------------- |
68
+ | **Model** | LEVUM |
69
+ | **Base** | Qwen 3.5 9B |
70
+ | **Parameters** | 9B |
71
+ | **Focus** | Code / Software |
72
+ | **Primary use** | Software development |
73
+ | **Execution** | Local |
74
+ | **Language** | English + multilingual capabilities of the base model |
75
+ | **Origin** | πŸ‡§πŸ‡· Brazil |
76
 
77
  ---
78
 
79
+ # Quantizations
80
 
81
+ LEVUM is available in different quantization levels to support a wider range of hardware.
82
 
83
+ The ideal choice mainly depends on:
84
 
85
+ **RAM / VRAM β†’ speed β†’ fidelity**
86
 
87
+ Comparison of the model's relative quality after different quantization levels:
88
 
89
  ![image](https://cdn-uploads.huggingface.co/production/uploads/644afe169279988e0cbcd2d9/Kqx6ACbFDrb_UG0Zmah4z.png)
90
 
91
+ Defined values: Q8 = 99%, Q4 = 50%, Q3 = 30%, Q2 = 25%, and Q1 = 10%.
92
 
93
+ ### Q8 β€” Fidelity
94
 
95
+ For machines with enough memory and users who want to preserve as much of the model's quality as possible.
96
 
97
  `Q8_0`
98
 
99
  ---
100
 
101
+ ### Q4 / IQ4 β€” Balanced
102
 
103
+ The recommended sweet spot for many local systems.
104
 
105
+ A good balance between size, memory usage, and quality.
106
 
107
  `Q4_K_M` Β· `Q4_K_S` Β· `IQ4_XS` Β· `IQ4_NL` Β· `Q4_1` Β· `Q4_0`
108
 
109
  ---
110
 
111
+ ### Q3 / IQ3 β€” Compact
112
 
113
+ For more limited hardware or situations where reducing RAM/VRAM usage is a priority.
114
 
115
  `Q3_K_L` Β· `Q3_K_M` Β· `Q3_K_S` Β· `IQ3_M` Β· `IQ3_S` Β· `IQ3_XS` Β· `IQ3_XXS`
116
 
117
  ---
118
 
119
+ ### Q2 / IQ2 β€” Ultra-Compact
120
 
121
+ Aggressive compression for environments where larger versions simply do not fit.
122
 
123
  `Q2_K` Β· `Q2_K_S` Β· `IQ2_M` Β· `IQ2_S` Β· `IQ2_XS` Β· `IQ2_XXS` Β· `Q2_0` Β· `TQ2_0`
124
 
125
  ---
126
 
127
+ ### IQ1 β€” Minimum
128
 
129
+ The extreme option.
130
 
131
  `IQ1_M`
132
 
133
+ Recommended only when saving memory is more important than preserving maximum model fidelity.
134
 
135
  ---
136
 
137
+ > **Rule of thumb:** start with `Q4_K_M`.
138
+ > If you have memory to spare, try `Q8_0`.
139
+ > If memory is limited, move down to Q3, Q2, or IQ1.
140
 
141
  ---
142
 
143
+ # Running Locally
144
 
145
  ## llama.cpp
146
 
147
+ Download one of the GGUF versions of LEVUM and run it with a GGUF-compatible runtime.
148
 
149
  ```bash
150
  llama-cli \
151
  -m ./LEVUM-Q4_K_M.gguf \
152
+ -p "Create a REST API in Python using FastAPI."
153
  ```
154
 
155
+ To start a local server:
156
 
157
  ```bash
158
  llama-server \
 
160
  -c 8192
161
  ```
162
 
163
+ After that, the model can be integrated with local tools that support compatible endpoints.
164
 
165
  ---
166
 
167
  ## Ollama
168
 
169
+ Create a `Modelfile` pointing to the GGUF:
170
 
171
  ```dockerfile
172
  FROM ./LEVUM-Q4_K_M.gguf
 
175
  PARAMETER top_p 0.9
176
  ```
177
 
178
+ Then:
179
 
180
  ```bash
181
  ollama create levum -f Modelfile
182
  ollama run levum
183
  ```
184
 
185
+ Example:
186
 
187
  ```text
188
+ >>> Create a FastAPI API for managing projects and tasks.
189
  ```
190
 
191
  ---
192
 
193
  ## LM Studio
194
 
195
+ 1. Download a GGUF quantization of LEVUM.
196
+ 2. Import the file into LM Studio.
197
+ 3. Load the model.
198
+ 4. Adjust the context size according to the available memory.
199
+ 5. Start a conversation or the local server.
200
 
201
+ No remote infrastructure is required for inference when the model is running locally.
202
 
203
  ---
204
 
205
  # Prompts
206
 
207
+ LEVUM works best when the task, context, and expected output format are explicit.
208
 
209
+ ## Generate a Project
210
 
211
  ```text
212
+ Create an interactive financial dashboard in a single HTML file.
213
 
214
+ Requirements:
215
+ - HTML, CSS, and JavaScript in the same file
216
+ - interactive charts
217
+ - responsive
218
+ - sample data
219
+ - no mandatory external dependencies
220
 
221
+ Return only the complete HTML.
222
  ```
223
 
224
  ---
225
 
226
+ ## Implement a Feature
227
 
228
  ```text
229
+ Analyze the code below and implement JWT authentication.
230
 
231
+ Requirements:
232
+ - preserve the current architecture
233
+ - validate expired tokens
234
+ - add authentication middleware
235
+ - do not modify public endpoints
236
+ - explain only important decisions
237
 
238
+ Code:
239
+ [paste the code here]
240
  ```
241
 
242
  ---
 
244
  ## Debug
245
 
246
  ```text
247
+ Find the cause of the bug in the code below.
248
 
249
+ Expected behavior:
250
+ [describe]
251
 
252
+ Current behavior:
253
+ [describe]
254
 
255
+ Error:
256
+ [paste the error]
257
 
258
+ Code:
259
+ [paste the code]
260
 
261
+ Identify the cause and return the complete fix.
262
  ```
263
 
264
  ---
265
 
266
+ ## Refactoring
267
 
268
  ```text
269
+ Refactor this code.
270
 
271
+ Goals:
272
+ - reduce duplication
273
+ - improve readability
274
+ - preserve current behavior
275
+ - preserve the public API
276
+ - avoid unnecessary abstractions
277
 
278
+ Return the refactored code first, followed by a short summary of the changes.
279
  ```
280
 
281
  ---
282
 
283
+ # Prompt Format
284
 
285
+ For larger tasks, a simple structure usually produces more predictable results:
286
 
287
  ```text
288
+ OBJECTIVE
289
+ What needs to be built.
290
 
291
+ CONTEXT
292
+ Stack, existing files, and architecture.
293
 
294
+ REQUIREMENTS
295
+ Mandatory behaviors.
296
 
297
+ CONSTRAINTS
298
+ What must not be changed.
299
 
300
+ OUTPUT
301
+ Exact expected format.
302
  ```
303
 
304
+ For example:
305
 
306
  ```text
307
+ OBJECTIVE
308
+ Create an analytics page.
309
 
310
+ CONTEXT
311
+ React + TypeScript + Tailwind project.
312
 
313
+ REQUIREMENTS
314
+ - revenue chart
315
+ - period filters
316
+ - metric cards
317
+ - transactions table
318
 
319
+ CONSTRAINTS
320
+ - do not add new dependencies
321
+ - reuse existing components
322
 
323
+ OUTPUT
324
+ Return the complete files that need to be created or modified.
325
  ```
326
 
327
  ---
328
 
329
  # Code-first
330
 
331
+ LEVUM was designed to work within the normal development cycle:
332
 
333
  ```text
334
+ PROMPT / CODE
335
  ↓
336
  LEVUM
337
  ↓
338
+ UNDERSTAND
339
  ↓
340
+ GENERATE
341
  ↓
342
  DEBUG
343
  ↓
344
+ REFACTOR
345
  ↓
346
+ RUNNING SOFTWARE
347
  ```
348
 
349
+ ### Generation
350
 
351
+ Projects, components, APIs, scripts, and features.
352
 
353
  ### Debug
354
 
355
+ Analysis of errors, unexpected behavior, and fixes.
356
 
357
+ ### Refactoring
358
 
359
+ Structure, readability, and maintenance of existing code.
360
 
361
+ ### Prototyping
362
 
363
+ Turn an idea into something executable quickly.
364
 
365
  ---
366
 
367
+ # Example
368
 
369
  **Prompt**
370
 
371
  ```text
372
+ Create a Flappy Bird-style game in a single HTML file.
373
 
374
+ Use only HTML, CSS, and JavaScript.
375
 
376
+ Include:
377
+ - physics
378
+ - obstacles
379
+ - collision detection
380
+ - scoring
381
+ - restart
382
+ - keyboard and click controls
383
 
384
+ Return only the complete HTML.
385
  ```
386
 
387
+ **Expected result**
388
 
389
  ```text
390
  prompt
 
395
  ↓
396
  browser
397
  ↓
398
+ running software
399
  ```
400
 
401
  ---
402
 
403
  # Hardware
404
 
405
+ Actual resource usage depends on several factors, including:
406
 
407
+ * quantization;
408
+ * context size;
409
  * runtime;
410
  * KV cache;
411
  * CPU;
412
  * GPU;
413
+ * number of layers offloaded to the GPU;
414
+ * inference configuration.
415
 
416
+ Because of this, memory requirements can vary significantly between systems.
417
 
418
+ As a general rule:
419
 
420
  ```text
421
+ more bits
422
  ↑
423
+ more fidelity
424
  ↑
425
+ more memory
426
 
427
+ fewer bits
428
  ↓
429
+ less memory
430
  ↓
431
+ more compression
432
  ```
433
 
434
+ Choose the quantization based on the available hardware and the quality required for the task.
435
 
436
  ---
437
 
438
+ # Limitations
439
 
440
+ LEVUM is still a language model.
441
 
442
+ This means it may:
443
 
444
+ * generate incorrect code;
445
+ * hallucinate APIs or libraries;
446
+ * produce insecure solutions;
447
+ * misinterpret requirements;
448
+ * introduce regressions;
449
+ * suggest nonexistent dependencies;
450
+ * generate code that looks correct without actually working.
451
 
452
+ For important software, review, test, and validate the code before putting it into production.
453
 
454
+ AI-generated code does not gain magical powers just because it compiled once.
455
 
456
  ---
457
 
458
+ # Responsible Use
459
 
460
+ Before running code generated by the model:
461
 
462
+ 1. review the changes;
463
+ 2. verify dependencies;
464
+ 3. run tests;
465
+ 4. validate external inputs;
466
+ 5. review filesystem, network, and database operations;
467
+ 6. do not expose secrets or credentials unnecessarily;
468
+ 7. use isolated environments when testing unknown code.
469
 
470
+ For critical applications, the model should serve as an assistance tool, not as the only layer of review.
471
 
472
  ---
473
 
474
+ # Base Model
475
 
476
+ LEVUM is based on:
477
 
478
  **Qwen 3.5 9B**
479
 
480
+ The base model provides the general capabilities upon which LEVUM is built.
481
 
482
+ Also review the base model's model card and license before distributing or using derivatives.
483
 
484
  ---
485
 
486
+ # License
487
 
488
+ Use of LEVUM is subject to the license published in this repository and, where applicable, the terms and conditions associated with the base model.
489
 
490
+ Review the `LICENSE` file before commercial use, redistribution, or creating derivatives.
491
 
492
  ---
493
 
494
+ # Brazil
495
 
496
  <div align="center">
497
 
498
+ ### πŸ‡§πŸ‡· MADE IN BRAZIL
499
 
500
+ **Intelligence that stays close.**
501
 
502
  Local-first Β· Code-first Β· Software-first
503
 
 
509
 
510
  **LEVUM Β© 2026**
511
 
512
+ </div>