Skip to content

Comments

docs: update Ollama setup instructions and add troubleshooting section#337

Merged
hannesrudolph merged 1 commit intomainfrom
olamaupdate
Sep 8, 2025
Merged

docs: update Ollama setup instructions and add troubleshooting section#337
hannesrudolph merged 1 commit intomainfrom
olamaupdate

Conversation

@hannesrudolph
Copy link
Collaborator

@hannesrudolph hannesrudolph commented Sep 8, 2025

Important

Update Ollama setup instructions and add troubleshooting for out-of-memory errors in docs/providers/ollama.md.

  • Documentation Updates:
    • Update Ollama setup instructions in docs/providers/ollama.md to clarify model configuration, specifically context window settings.
    • Add a troubleshooting section for out-of-memory errors, detailing symptoms, causes, and fixes.
  • Model Configuration:
    • Clarify that Roo automatically reads the model's context window from Ollama, removing the need for Roo-side context size settings.
    • Provide steps to preload models and pin context windows using interactive sessions or Modelfiles.
  • Troubleshooting:
    • Add solutions for out-of-memory errors, including preloading models, pinning context windows, using smaller model variants, and restarting after errors.

This description was created by Ellipsis for 44e1efc. You can customize this summary. It will automatically update as commits are pushed.

Copilot AI review requested due to automatic review settings September 8, 2025 20:27
@vercel
Copy link

vercel bot commented Sep 8, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
roo-code-docs Building Building Preview Comment Sep 8, 2025 8:27pm

@hannesrudolph hannesrudolph merged commit 05b986d into main Sep 8, 2025
2 of 3 checks passed
@hannesrudolph hannesrudolph deleted the olamaupdate branch September 8, 2025 20:27
@github-project-automation github-project-automation bot moved this from Triage to Done in Roo Code Roadmap Sep 8, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Ollama setup documentation to improve user experience with better setup instructions and troubleshooting guidance. The changes clarify how Roo handles context windows automatically and provide comprehensive help for common issues.

  • Simplified context window configuration instructions to reflect automatic handling
  • Updated setup steps to include API key configuration and clarify model naming
  • Added comprehensive troubleshooting section for out-of-memory issues

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

**Fixes**
1. **Preload the model**
```bash
ollama run <model-name>
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML entities &lt; should be < in the bash code block. This appears to be an encoding issue.

Copilot uses AI. Check for mistakes.
2. **Pin the context window (`num_ctx`)**
- Option A — interactive session, then save:
```bash
# inside `ollama run &lt;base-model&gt;`
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML entities &lt; and &gt; should be < and > respectively in the bash code blocks.

Copilot uses AI. Check for mistakes.
```bash
# inside `ollama run &lt;base-model&gt;`
/set parameter num_ctx 32768
/save &lt;your_model_name&gt;
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML entities &lt; and &gt; should be < and > respectively in the bash code blocks.

Copilot uses AI. Check for mistakes.
```
Then re-create the model:
```bash
ollama create &lt;your_model_name&gt; -f Modelfile
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML entities &lt; and &gt; should be < and > respectively in the bash code block.

Copilot uses AI. Check for mistakes.
5. **Restart after an OOM**
```bash
ollama ps
ollama stop &lt;model-name&gt;
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTML entities &lt; and &gt; should be < and > respectively in the bash code block.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant