Skip to content

Commit

Permalink
Adds getting started code
Browse files Browse the repository at this point in the history
  • Loading branch information
edgararuiz committed Apr 6, 2024
1 parent bddad6e commit fc8aeb3
Showing 1 changed file with 16 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,20 @@ knitr::opts_chunk$set(
```


## Works with Copilot and ChatGPT
## Getting started

```r
chattr::chattr_app()

#> ── chattr - Available models
#>
#> 1: GitHub - Copilot Chat - (copilot)
#> 2: OpenAI - Chat Completions - gpt-3.5-turbo (gpt35)
#> 3: OpenAI - Chat Completions - gpt-4 (gpt4)
#> 4: LlamaGPT - ~/ggml-gpt4all-j-v1.3-groovy.bin (llamagpt)
#>
#> Select the number of the model you would like to use:
```

## Works with local LLMs

Expand All @@ -48,7 +61,8 @@ application by starting an 'hidden' terminal session, where it initializes the
selected model, and makes it available to start chatting with it.

To get started, you need to install LlamaGPTJ-chat, and download a compatible
model. More detailed instructions are found [here](https://mlverse.github.io/chattr/articles/backend-llamagpt.html#installation).
model. More detailed instructions are found
[here](https://mlverse.github.io/chattr/articles/backend-llamagpt.html#installation).

## Integrating with `chattr`

Expand Down

1 comment on commit fc8aeb3

@github-actions
Copy link

Choose a reason for hiding this comment

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

Please sign in to comment.