Skip to content
This repository has been archived by the owner on Jan 31, 2025. It is now read-only.

Commit

Permalink
Add ollama example to README
Browse files Browse the repository at this point in the history
I just spent a while trying to understand how to use a locally-running ollama instance, so adding some documentation to the README that would have saved me some time.
  • Loading branch information
devvmh committed Jan 4, 2025
1 parent 22b205d commit 805bc91
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The skill utilizes the `~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.ope
}
```

### Configuration for use with Local AI
### Configuration for use with llama.cpp

```json
{
Expand All @@ -70,6 +70,29 @@ The skill utilizes the `~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.ope
}
```

### Configuration for use with a locally-running instance of ollama

See [Ollama OpenAI Compatibility](https://ollama.com/blog/openai-compatibility)

```json
{
"api_url": "http://localhost:11434/v1",
"model": "llama3:latest",
"key": "sk-xxx",
"persona": "You are a helpful voice assistant with a friendly tone and fun sense of humor. You respond in 40 words or fewer.",
"enable_memory": true,
"memory_size": 15,
"name": "llama",
"confirmation": false,
"__mycroft_skill_firstrun": false
}
```

## See also

- [OVOS OpenAI Persona Plugin](https://github.com/OpenVoiceOS/ovos-solver-openai-persona-plugin) - The underlying plugin that powers this skill's integration with various AI models.


## Examples

- "Explain quantum computing in simple terms"
Expand Down

0 comments on commit 805bc91

Please sign in to comment.