Skip to content

Commit

Permalink
add more docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelcolvin authored Dec 14, 2024
1 parent a5e69ca commit 46b8bf0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,16 @@
GitHub Action to install ollama, pull a model and run the ollama server.

Both the ollama install and the model are cached between runs.

Example usage:

```yaml
- uses: pydantic/ollama-action@v3
with:
model: qwen2:0.5b
```
We can then run tests and connect to `http://localhost:11434` to make requests to ollama. Here we use the [`qwen2:0.5b`](https://ollama.com/library/qwen2:0.5b) model as it's very small and therefore quick to download.

This action is used by [`pydantic-ai`](https://github.com/pydantic/pydantic-ai).

0 comments on commit 46b8bf0

Please sign in to comment.