| --- |
| language: |
| - pt |
| license: apache-2.0 |
| tags: |
| - spiritism |
| - kardec |
| - espiritismo |
| - allan-kardec |
| - religion |
| - portuguese |
| - brazilian |
| - fine-tuned |
| - qlora |
| - llama-3 |
| - spirituality |
| - riv-ai |
| - espírita |
| - unsloth |
| - GGUF |
| - llama.cpp |
| datasets: |
| - ia-espirita/riv-ai-dataset |
| base_model: meta-llama/Meta-Llama-3-8B-Instruct |
| pipeline_tag: text-generation |
| model-index: |
| - name: riv-ai |
| results: [] |
| new_version: ia-espirita/riv-ai-v2 |
| --- |
| |
| # 🔮 RIV AI — Modelo de IA Espírita Open Source |
|
|
| <p align="center"> |
| <img src="https://img.shields.io/badge/Doutrina-Espírita-6B0FD4?style=for-the-badge" /> |
| <img src="https://img.shields.io/badge/Allan_Kardec-1857-00D4FF?style=for-the-badge" /> |
| <img src="https://img.shields.io/badge/Língua-Português_BR-green?style=for-the-badge" /> |
| <img src="https://img.shields.io/badge/Fine--tuning-QLoRA-orange?style=for-the-badge" /> |
| <img src="https://img.shields.io/badge/GGUF-Q4__K__M-red?style=for-the-badge" /> |
| </p> |
|
|
| **RIV AI** (homenagem a Hippolyte Léon Denizard **Riv**ail — Allan Kardec) é um modelo de linguagem open-source treinado na **Doutrina Espírita**, conforme codificada por **Allan Kardec**. |
|
|
| O modelo foi fine-tunado via **QLoRA** sobre o **Llama 3 8B Instruct** com um dataset de pares de pergunta/resposta extraídos das 5 obras da Codificação Espírita. O objetivo é oferecer um assistente que responda sobre a Doutrina com **fidelidade doutrinária** e **citação de fontes**, servindo como ferramenta de estudo e divulgação. |
|
|
| > *"O Espiritismo é uma ciência que trata da natureza, origem e destino dos Espíritos, bem como de suas relações com o mundo corporal."* |
| > — Allan Kardec, O Livro dos Espíritos, Introdução. |
|
|
| --- |
|
|
| ## 📦 Arquivos disponíveis |
|
|
| | Arquivo | Formato | Tamanho | Uso | |
| |---------|---------|---------|-----| |
| | `meta-llama-3.1-8b-instruct.Q4_K_M.gguf` | GGUF 4-bit | ~4.9 GB | Ollama, LM Studio, llama.cpp | |
| | `adapter_model.safetensors` | Safetensors | — | Transformers + PEFT (Python) | |
|
|
| --- |
|
|
| ## 🎯 Para que serve? |
|
|
| Este modelo foi criado para responder perguntas sobre a Doutrina Espírita com: |
|
|
| - **Precisão doutrinária** — fundamentado exclusivamente nas obras de Allan Kardec |
| - **Citação de fontes** — toda resposta referencia livro, questão e/ou capítulo |
| - **Tom acolhedor e didático** — como um amigo estudioso explicando Kardec |
| - **Analogias modernas** — traduz conceitos espíritas para linguagem contemporânea quando apropriado |
| - **Português brasileiro** — treinado nativamente em PT-BR |
|
|
| ### Exemplos de perguntas que o modelo responde: |
|
|
| | Pergunta | Fonte da resposta | |
| |----------|-------------------| |
| | O que é Deus? | O Livro dos Espíritos, questão 1 | |
| | Eu escolhi minha família antes de nascer? | O Livro dos Espíritos, questões 392-399 | |
| | Animais têm alma? | O Livro dos Espíritos, questões 597-602 | |
| | O que acontece quando morremos? | O Livro dos Espíritos, questões 149-165 | |
| | O que é mediunidade? | O Livro dos Médiuns, cap. 14, itens 159-160 | |
| | O que é o perispírito? | O Livro dos Espíritos, questões 93-95 | |
| | Inteligência Artificial tem espírito? | O Livro dos Espíritos, questões 23, 71-75 | |
| | Existe céu e inferno? | O Céu e o Inferno, Parte Primeira | |
| | Como fazer o Evangelho no Lar? | O Evangelho Segundo o Espiritismo, cap. 28 | |
| | Ciência e Espiritismo se contradizem? | A Gênese, cap. 1 | |
|
|
| --- |
|
|
| ## 💻 Como usar |
|
|
| ### Com Ollama |
| ```bash |
| ollama run iaespirita/riv-ai |
| ``` |
|
|
| Modelo disponível em: [ollama.com/iaespirita/riv-ai](https://ollama.com/iaespirita/riv-ai) |
|
|
| ### Com LM Studio |
|
|
| 1. Baixe o arquivo `meta-llama-3.1-8b-instruct.Q4_K_M.gguf` |
| 2. Abra o LM Studio e importe o arquivo |
| 3. Configure o system prompt: *"Você é RIV AI, um assistente espírita fundamentado nas obras de Allan Kardec."* |
| 4. Comece a conversar |
|
|
| ### Com llama.cpp |
|
|
| ```bash |
| llama-cli -hf ia-espirita/riv-ai --jinja |
| ``` |
|
|
| ### Com Transformers (Python) |
|
|
| ```python |
| from transformers import AutoTokenizer, AutoModelForCausalLM |
| |
| model_name = "ia-espirita/riv-ai" |
| tokenizer = AutoTokenizer.from_pretrained(model_name) |
| model = AutoModelForCausalLM.from_pretrained(model_name) |
| |
| messages = [ |
| {"role": "system", "content": "Você é RIV AI, um assistente espírita fundamentado nas obras de Allan Kardec."}, |
| {"role": "user", "content": "O que acontece quando morremos?"} |
| ] |
| |
| input_ids = tokenizer.apply_chat_template(messages, return_tensors="pt") |
| output = model.generate(input_ids, max_new_tokens=512, temperature=0.7) |
| print(tokenizer.decode(output[0], skip_special_tokens=True)) |
| ``` |
|
|
| ### Com vLLM (API) |
|
|
| ```bash |
| python -m vllm.entrypoints.openai.api_server \ |
| --model ia-espirita/riv-ai \ |
| --port 8000 |
| ``` |
|
|
| --- |
|
|
| ## 📚 Fontes do treinamento |
|
|
| O dataset foi construído exclusivamente a partir da **Codificação Espírita** — as 5 obras fundamentais organizadas por Allan Kardec: |
|
|
| | Obra | Ano | Estrutura | Tema central | |
| |------|-----|-----------|--------------| |
| | **O Livro dos Espíritos** | 1857 | 1.019 questões em 4 partes | Deus, espíritos, leis morais, vida futura | |
| | **O Livro dos Médiuns** | 1861 | 32 capítulos, 370 itens | Mediunidade, manifestações e comunicação espírita | |
| | **O Evangelho Segundo o Espiritismo** | 1864 | 28 capítulos | Moral de Jesus à luz do Espiritismo | |
| | **O Céu e o Inferno** | 1865 | 2 partes (doutrina + relatos) | Justiça divina, penas e recompensas futuras | |
| | **A Gênese** | 1868 | 18 capítulos | Ciência e Espiritismo: criação, milagres, profecias | |
|
|
| Todas as obras são de **domínio público** (publicadas entre 1857-1868). |
|
|
| --- |
|
|
| ## 🔧 Detalhes técnicos |
|
|
| | Parâmetro | Valor | |
| |-----------|-------| |
| | **Modelo base** | `meta-llama/Meta-Llama-3.1-8B-Instruct` | |
| | **Método de fine-tuning** | QLoRA (4-bit quantization) | |
| | **Framework** | Unsloth (2x faster) | |
| | **Dataset** | ~1.200 pares Q&A no formato ShareGPT | |
| | **Fontes** | 5 obras da Codificação Espírita (Allan Kardec) | |
| | **Idioma** | Português Brasileiro | |
| | **Épocas** | 3 | |
| | **Learning rate** | 2e-4 | |
| | **LoRA rank** | 16 | |
| | **LoRA alpha** | 32 | |
| | **Max seq length** | 2048 | |
| | **Training loss** | 0.64 (final step) | |
| | **GGUF quantization** | Q4_K_M (~4.9 GB) | |
|
|
| --- |
|
|
| ## 📊 Dataset |
|
|
| O dataset está publicado em [`ia-espirita/riv-ai-dataset`](https://huggingface.co/datasets/ia-espirita/riv-ai-dataset). |
|
|
| ### Distribuição por obra |
|
|
| | Fonte | Pares | |
| |-------|-------| |
| | O Livro dos Espíritos | ~500 | |
| | O Livro dos Médiuns | ~250 | |
| | O Evangelho Segundo o Espiritismo | ~200 | |
| | O Céu e o Inferno | ~100 | |
| | A Gênese | ~100 | |
| | Temas gerais / modernos / existenciais | ~150 | |
|
|
| ### Formato |
|
|
| ```json |
| { |
| "conversations": [ |
| {"from": "human", "value": "Animais têm alma segundo a Doutrina Espírita?"}, |
| {"from": "gpt", "value": "Sim, os animais possuem um princípio inteligente que sobrevive à morte do corpo físico. Esse princípio evolui progressivamente através dos reinos da natureza...\n\n📖 Fonte: O Livro dos Espíritos, questões 597-602."} |
| ] |
| } |
| ``` |
|
|
| --- |
|
|
| ## 🔮 Por que "RIV"? |
|
|
| **RIV** é uma homenagem a **Riv**ail — o verdadeiro nome de Allan Kardec. |
|
|
| Hippolyte Léon Denizard Rivail (1804-1869) foi o pedagogo francês que codificou a Doutrina Espírita. Ele adotou o pseudônimo "Allan Kardec" para separar seu trabalho acadêmico da obra espírita. O nome RIV AI conecta a tradição kardecista com a era da inteligência artificial — o passado e o futuro do conhecimento espírita. |
|
|
| --- |
|
|
| ## ⚠️ Limitações e uso responsável |
|
|
| - Este modelo é uma **ferramenta de estudo**, não substitui a leitura das obras originais de Allan Kardec |
| - Não é um médium e não recebe mensagens de espíritos |
| - Não faz previsões do futuro nem prescreve tratamentos médicos |
| - Para questões de mediunidade prática, sempre procure um centro espírita presencialmente |
| - O modelo pode ocasionalmente gerar informações imprecisas — sempre verifique nas fontes originais |
| - Para temas sensíveis como suicídio, o modelo inclui orientação para o CVV (188) |
| - O dataset deste modelo cobre exclusivamente a Codificação de Allan Kardec. Para conteúdo da série André Luiz (psicografia de Chico Xavier), use o modelo companheiro [`ia-espirita/andre-luiz-ai`](https://huggingface.co/ia-espirita/andre-luiz-ai). Obras de Emmanuel, Divaldo Franco e outros autores mediúnicos poderão ser incluídas em versões futuras |
| --- |
|
|
| ## 🗺️ Roadmap |
|
|
| - [x] v1.0 — Codificação Espírita (5 obras de Allan Kardec) |
| - [x] v2.0 — Codificação Espírita (5 obras de Allan Kardec + Revistas Espíritas + O que é o espiritismo) |
| - [ ] v3.0 — Obras de Emmanuel, Divaldo Franco, ESDE |
| - [ ] v4.0 — Versão em Espanhol (es) |
| - [ ] v5.0 — Versão em Inglês (en) |
|
|
| --- |
|
|
| ## 🌐 Projeto IA.Espirita |
|
|
| O RIV AI é a versão open-source aberta do projeto IA.Espirita — Doutrina Espírita na Era da Inteligência Artificial. O RIV IA (iaespirita.com/riv) usa uma arquitetura mais robusta (modelo base maior com reasoning + RAG estrito sobre o mesmo corpus), enquanto este modelo é publicado como artefato de pesquisa, replicação e deploy offline. |
| | Plataforma | Link | |
| |------------|------| |
| | 🌐 Site | [iaespirita.com](https://iaespirita.com) | |
| | 🤖 RIV IA | [Converse agora](https://iaespirita.com/riv) | |
| | ▶️ YouTube | [@ia.espirita](https://youtube.com/@ia.espirita) | |
| | 🎵 TikTok | [@ia.espirita](https://tiktok.com/@ia.espirita) | |
| | 🎧 Spotify | [IA Espirita](https://open.spotify.com/show/4Xf22wuDUlJUnMx2hjWV7A) | |
| | 🐦 X/Twitter | [@IAEspiritaBR](https://x.com/IAEspiritaBR) | |
| | 📧 E-mail | [contato@iaespirita.com.br](mailto:contato@iaespirita.com.br) | |
|
|
|
|
| --- |
|
|
| ## 📜 Licença |
|
|
| O modelo é distribuído sob licença **Apache 2.0**. |
|
|
| As obras de Allan Kardec são de **domínio público** (publicadas entre 1857-1868). |
|
|
| --- |
|
|
| ## 🙏 Citação |
|
|
| ```bibtex |
| @misc{iaespirita2026rivai, |
| title={RIV AI: Modelo de IA Espírita Open Source}, |
| author={IA.Espirita}, |
| year={2026}, |
| url={https://huggingface.co/ia-espirita/riv-ai}, |
| note={Fine-tuned on Llama 3 8B Instruct with QLoRA using Allan Kardec's complete codification} |
| } |
| ``` |
|
|
| --- |
|
|
| ## 🤝 Contribuições |
|
|
| Contribuições são bem-vindas! Se você é estudioso da Doutrina Espírita e/ou desenvolvedor: |
|
|
| - 📝 Revise e expanda o dataset com novas perguntas e respostas |
| - 🧪 Teste o modelo e reporte erros doutrinários |
| - 🌍 Ajude a traduzir o dataset para espanhol e inglês |
| - 📚 Contribua com dados de obras mediúnicas para as próximas versões |
|
|
| Abra uma issue ou pull request neste repositório. |
|
|
| --- |
|
|
| <p align="center"> |
| <img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/> |
| <br> |
| <i>"Nascer, morrer, renascer ainda e progredir sem cessar, tal é a Lei."</i><br> |
| — Allan Kardec, epitáfio em seu túmulo no cemitério Père-Lachaise, Paris. |
| </p> |
