forefront possibility of local model in docs (closes #63)

simonpcouch · Nov 21, 2024 · 83bcccb · 83bcccb
1 parent ae27a02
commit 83bcccb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -31,7 +31,7 @@ You can install pal like so:
 pak::pak("simonpcouch/pal")
 ```
 
-Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT—to power the pal, see the [Getting started with pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette.
+Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT or a local ollama model—to power the pal, see the [Getting started with pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette.
 
 Pals are interfaced with the via the pal addin. For easiest access, we recommend registering the pal addin to a keyboard shortcut.
 

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ pak::pak("simonpcouch/pal")
 Then, ensure that you have an
 [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment
 variable set, and you’re ready to go. If you’d like to use an LLM other
-than Anthropic’s Claude 3.5 Sonnet—like OpenAI’s ChatGPT—to power the
+than Anthropic’s Claude 3.5 Sonnet—like OpenAI’s ChatGPT or a local ollama model—to power the
 pal, see the [Getting started with
 pal](https://simonpcouch.github.io/pal/articles/pal.html) vignette.
 

diff --git a/vignettes/pal.Rmd b/vignettes/pal.Rmd
@@ -47,6 +47,15 @@ options(
 )
 ```
 
+To use a local model with ollama, you might write:
+
+```r
+options(
+  .pal_fn = "chat_ollama",
+  .pal_args = list(model = "qwen2.5-coder:14b")
+)
+```
+
 You'll probably want pal to always use whichever model you're configuring with this option. To make this selection persist across sessions, add that `options()` code to your `.Rprofile`. You might use `usethis::edit_r_profile()` to open the file. After making those changes and restarting R, your pal will use the new model.
 
 ## The pal addin