Update README.md
Browse files
README.md
CHANGED
|
@@ -1,202 +1,134 @@
|
|
| 1 |
---
|
| 2 |
base_model: nicholasKluge/TeenyTinyLlama-460m
|
| 3 |
-
library_name:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
|
|
|
| 5 |
|
| 6 |
-
|
| 7 |
|
| 8 |
-
|
| 9 |
|
|
|
|
| 10 |
|
|
|
|
|
|
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
-
|
| 15 |
|
| 16 |
-
|
| 17 |
|
|
|
|
| 18 |
|
|
|
|
| 19 |
|
| 20 |
-
-
|
| 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 |
-
|
| 29 |
|
| 30 |
-
|
| 31 |
|
| 32 |
-
-
|
| 33 |
-
- **Paper [optional]:** [More Information Needed]
|
| 34 |
-
- **Demo [optional]:** [More Information Needed]
|
| 35 |
|
| 36 |
-
|
| 37 |
|
| 38 |
-
|
| 39 |
|
| 40 |
-
|
| 41 |
|
| 42 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 43 |
|
| 44 |
-
|
| 45 |
|
| 46 |
-
|
| 47 |
|
| 48 |
-
|
| 49 |
|
| 50 |
-
|
| 51 |
|
| 52 |
-
|
| 53 |
|
| 54 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
-
|
| 57 |
|
| 58 |
-
|
| 59 |
|
| 60 |
-
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
-
|
| 63 |
|
| 64 |
-
|
|
|
|
|
|
|
| 65 |
|
| 66 |
-
|
| 67 |
|
| 68 |
-
|
|
|
|
|
|
|
| 69 |
|
| 70 |
-
|
| 71 |
|
| 72 |
-
|
|
|
|
|
|
|
|
|
|
| 73 |
|
| 74 |
-
|
| 75 |
|
| 76 |
-
|
| 77 |
|
| 78 |
-
|
| 79 |
|
| 80 |
-
|
| 81 |
|
| 82 |
-
|
| 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 |
-
|
| 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 |
-
|
|
|
|
| 182 |
|
| 183 |
-
|
| 184 |
|
| 185 |
-
|
| 186 |
|
| 187 |
-
|
| 188 |
|
| 189 |
-
|
| 190 |
|
| 191 |
-
|
| 192 |
|
| 193 |
-
|
| 194 |
|
| 195 |
-
|
| 196 |
|
| 197 |
-
|
|
|
|
|
|
|
| 198 |
|
| 199 |
-
|
| 200 |
-
### Framework versions
|
| 201 |
|
| 202 |
-
|
|
|
|
| 1 |
---
|
| 2 |
base_model: nicholasKluge/TeenyTinyLlama-460m
|
| 3 |
+
library_name: transformers
|
| 4 |
+
license: cc-by-nc-nd-4.0
|
| 5 |
+
language:
|
| 6 |
+
- pt
|
| 7 |
+
pipeline_tag: text-generation
|
| 8 |
+
datasets:
|
| 9 |
+
- cnmoro/LogicReasoningEnglishPortuguese
|
| 10 |
+
metrics:
|
| 11 |
+
- accuracy
|
| 12 |
---
|
| 13 |
+
# 🧠 WNL468M — Modelo de Raciocínio Lógico em Português para Ensino e Educação
|
| 14 |
|
| 15 |
+
**WNL268M** é um modelo de linguagem com aproximadamente **268 milhões de parâmetros**, desenvolvido especialmente para tarefas de **raciocínio lógico** e compreensão em **português**, com foco em **ensino, educação e suporte acadêmico**. Este projeto foi inspirado e criado para um **projeto acadêmico** de destaque em uma **feira de ciências**, com o objetivo de contribuir para o avanço do ensino de inteligência artificial aplicada ao idioma português.
|
| 16 |
|
| 17 |
+
## ✨ Origem do Nome
|
| 18 |
|
| 19 |
+
**WNL** é uma homenagem a três colegas que foram a inspiração inicial para o projeto:
|
| 20 |
|
| 21 |
+
- **W** — Weia
|
| 22 |
+
- **N** — Nauria
|
| 23 |
+
- **L** — Leonilda
|
| 24 |
|
| 25 |
+
Embora elas não participem diretamente, seus nomes simbolizam a motivação que deu origem ao desenvolvimento do modelo.
|
| 26 |
|
| 27 |
+
## 👥 Equipe Fundadora
|
| 28 |
|
| 29 |
+
- Marius Jabami – Desenvolvedor principal, integração com modelo, lógica central e liderança técnica
|
| 30 |
|
| 31 |
+
- Ilson Lopes – Apoio geral ao desenvolvimento e testes técnicos
|
| 32 |
|
| 33 |
+
- Délcio Pro – Interface visual (Kivy), processamento de texto, usabilidade
|
| 34 |
|
| 35 |
+
- José Bukete – Lógica do chat em Kivy, controle de eventos e exibição de mensagens
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
+
- Fernando Queta – Integração com modelo Transformers, geração de respostas
|
| 38 |
|
| 39 |
+
- Inácio Oicani – Histórico de conversa, normalização de texto, refinamento de UI/UX
|
| 40 |
|
| 41 |
+
- Daniel Raimundo – Estilo visual, fontes, cores, animações e experiência do usuário
|
|
|
|
|
|
|
| 42 |
|
| 43 |
+
- Celsio Simplício – Testes, simulações, depuração e melhoria de desempenho
|
| 44 |
|
| 45 |
+
- Arsênio Afonso – Suporte em testes e revisão técnica
|
| 46 |
|
| 47 |
+
- Cristiano Jomba – Testes diversos, análise de comportamento do chatbot
|
| 48 |
|
|
|
|
| 49 |
|
| 50 |
+
## 🧩 Dataset Utilizado
|
| 51 |
|
| 52 |
+
O modelo foi finamente ajustado utilizando o dataset:
|
| 53 |
|
| 54 |
+
📚 [`cnmoro/LogicReasoningEnglishPortuguese`](https://huggingface.co/datasets/cnmoro/LogicReasoningEnglishPortuguese)
|
| 55 |
|
| 56 |
+
Este conjunto bilíngue contém pares de perguntas e respostas que exigem **raciocínio lógico**, proporcionando uma base robusta para treinar o modelo em tarefas de compreensão, dedução e resposta estruturada, essenciais para aplicações educacionais.
|
| 57 |
|
| 58 |
+
## 🔍 Informações Técnicas Detalhadas
|
| 59 |
|
| 60 |
+
- **Parâmetros:** ~468 milhões
|
| 61 |
+
- **Arquitetura Base:** Adaptada do LLaMA, conhecida pela eficiência em tarefas de linguagem natural
|
| 62 |
+
- **Tokenizador:** SentencePiece (formato LLaMA)
|
| 63 |
+
- **Método de Treinamento:** Fine-tuning com LoRA, seguido de mesclagem dos pesos para otimização
|
| 64 |
+
- **Framework:** PyTorch com Hugging Face Transformers
|
| 65 |
+
- **Tipo de Modelo:** Causal Language Model (modelo generativo para texto)
|
| 66 |
+
- **Idiomas:** Português (principal), com suporte a dados em inglês do dataset bilíngue
|
| 67 |
+
- **Uso:** Aplicações educacionais, chatbots acadêmicos, ferramentas de ensino e suporte ao raciocínio lógico
|
| 68 |
|
| 69 |
+
## 🎯 Propósito e Aplicações
|
| 70 |
|
| 71 |
+
O **WNL268M** foi desenvolvido com foco pedagógico, visando:
|
| 72 |
|
| 73 |
+
- Facilitar o aprendizado e o ensino de lógica e raciocínio no idioma português
|
| 74 |
+
- Servir como base para projetos acadêmicos e feiras de ciências, mostrando a viabilidade de modelos customizados para educação
|
| 75 |
+
- Criar ferramentas interativas que ajudem estudantes e educadores a explorarem conceitos complexos de forma acessível e inteligente
|
| 76 |
+
- Demonstrar que projetos de IA podem ser desenvolvidos colaborativamente em ambientes educacionais
|
| 77 |
|
| 78 |
+
## 💻 Como Usar o Modelo
|
| 79 |
|
| 80 |
+
```python
|
| 81 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM, TextStreamer
|
| 82 |
+
import torch
|
| 83 |
|
| 84 |
+
repo_id = "lambdaindie/WNL468M"
|
| 85 |
|
| 86 |
+
tokenizer = AutoTokenizer.from_pretrained(repo_id)
|
| 87 |
+
model = AutoModelForCausalLM.from_pretrained(repo_id, device_map="auto", torch_dtype=torch.float16)
|
| 88 |
+
model.eval()
|
| 89 |
|
| 90 |
+
streamer = TextStreamer(tokenizer)
|
| 91 |
|
| 92 |
+
while True:
|
| 93 |
+
prompt = input("Você: ")
|
| 94 |
+
inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
|
| 95 |
+
_ = model.generate(**inputs, max_new_tokens=100, streamer=streamer)
|
| 96 |
|
| 97 |
+
```
|
| 98 |
|
| 99 |
+
🚀 Próximos Passos
|
| 100 |
|
| 101 |
+
Ampliação do dataset com mais exemplos em português
|
| 102 |
|
| 103 |
+
Desenvolvimento de versões maiores com foco em domínio acadêmico específico
|
| 104 |
|
| 105 |
+
Integração com plataformas educacionais para testes reais em sala de aula
|
| 106 |
|
|
|
|
| 107 |
|
|
|
|
| 108 |
|
| 109 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 110 |
|
| 111 |
+
Criado com dedicação, conhecimento e fé no futuro da educação.
|
| 112 |
+
Equipe fundadora empenhada em transformar aprendizado através da inteligência artificial.
|
| 113 |
|
| 114 |
+
---
|
| 115 |
|
| 116 |
+
## 🔒 Licença
|
| 117 |
|
| 118 |
+
Este modelo está licenciado sob:
|
| 119 |
|
| 120 |
+
**[CC BY-NC-ND 4.0 (Creative Commons Attribution-NonCommercial-NoDerivatives 4.0)](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.pt)**
|
| 121 |
|
| 122 |
+
Você é livre para:
|
| 123 |
|
| 124 |
+
- Compartilhar — copiar e redistribuir o material em qualquer meio ou formato
|
| 125 |
|
| 126 |
+
Desde que siga os termos:
|
| 127 |
|
| 128 |
+
- **Atribuição** — Deve creditar os autores (ver seção "Equipe Fundadora").
|
| 129 |
+
- **Não Comercial** — Não pode usar o material para fins comerciais.
|
| 130 |
+
- **Sem Derivações** — Não pode remixar, transformar ou criar a partir do material.
|
| 131 |
|
| 132 |
+
Este modelo é exclusivo para fins **acadêmicos e educacionais**.
|
|
|
|
| 133 |
|
| 134 |
+
---
|