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 4 days ago

Commit

34e8a5d

verified ·

1 Parent(s): 51d286d

Update README.md

Browse files

Files changed (1) hide show

README.md +22 -21

README.md CHANGED Viewed

@@ -1,31 +1,32 @@
 ---
 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: []
 ---
 # 🔮 RIV AI — Modelo de IA Espírita Open Source
@@ -283,4 +284,4 @@ Abra uma issue ou pull request neste repositório.
   <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>

 ---
 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
   <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>