Instructions to use ia-espirita/riv-ai with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use ia-espirita/riv-ai with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="ia-espirita/riv-ai",
	filename="meta-llama-3.1-8b-instruct.Q4_K_M.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use ia-espirita/riv-ai with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf ia-espirita/riv-ai:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf ia-espirita/riv-ai:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf ia-espirita/riv-ai:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf ia-espirita/riv-ai:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf ia-espirita/riv-ai:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf ia-espirita/riv-ai:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf ia-espirita/riv-ai:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf ia-espirita/riv-ai:Q4_K_M

Use Docker

docker model run hf.co/ia-espirita/riv-ai:Q4_K_M

LM Studio
Jan

vLLM

How to use ia-espirita/riv-ai with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "ia-espirita/riv-ai"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "ia-espirita/riv-ai",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/ia-espirita/riv-ai:Q4_K_M

Ollama
How to use ia-espirita/riv-ai with Ollama:
```
ollama run hf.co/ia-espirita/riv-ai:Q4_K_M
```

Unsloth Studio new

How to use ia-espirita/riv-ai with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for ia-espirita/riv-ai to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for ia-espirita/riv-ai to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for ia-espirita/riv-ai to start chatting

Pi new

How to use ia-espirita/riv-ai with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf ia-espirita/riv-ai:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "riv-ai"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use ia-espirita/riv-ai with Docker Model Runner:
```
docker model run hf.co/ia-espirita/riv-ai:Q4_K_M
```

Lemonade

How to use ia-espirita/riv-ai with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull ia-espirita/riv-ai:Q4_K_M

Run and chat with the model

lemonade run user.riv-ai-Q4_K_M

List all available models

lemonade list

ia-espirita commited on 13 days ago

Commit

3d23df2

verified ·

1 Parent(s): 12da07c

Update README.md

Browse files

Files changed (1) hide show

README.md +3 -6

README.md CHANGED Viewed

@@ -214,15 +214,13 @@ Hippolyte Léon Denizard Rivail (1804-1869) foi o pedagogo francês que codifico
 - 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 atual cobre exclusivamente a Codificação de Kardec — obras mediúnicas de Chico Xavier, Divaldo Franco e outros poderão ser incluídas em versões futuras
 ---
 ## 🗺️ Roadmap
 - [x] v1.0 — Codificação Espírita (5 obras de Allan Kardec)
-- [ ] v2.0 — Série André Luiz (14 livros, Chico Xavier)
-- [ ] v3.0 — Obras de Emmanuel, Divaldo Franco, ESDE
 - [ ] v4.0 — Versão em Espanhol (es)
 - [ ] v5.0 — Versão em Inglês (en)
@@ -230,8 +228,7 @@ Hippolyte Léon Denizard Rivail (1804-1869) foi o pedagogo francês que codifico
 ## 🌐 Projeto IA.Espirita
-O RIV AI é o cérebro por trás do **RIV IA**, o chatbot espírita do projeto **IA.Espirita** — Doutrina Espírita na Era da Inteligência Artificial.
 | Plataforma | Link |
 |------------|------|
 | 🌐 Site | [iaespirita.com](https://iaespirita.com) |

 - 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 — Série André Luiz (13 livros psicografados por Chico Xavier) — modelo companheiro publicado em [`ia-espirita/andre-luiz-ai`](https://huggingface.co/ia-espirita/andre-luiz-ai) e disponível em produção em [iaespirita.com/andre-luiz/chat](https://iaespirita.com/andre-luiz/chat)[ ] 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) |