Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed the settings file to allow users to override it #19

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
gpt-settings.talon
File renamed without changes.
12 changes: 5 additions & 7 deletions GPT/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Query language models with voice commands. Helpful to automatically generate tex

- See the [examples file](./examples.md) for gifs that show how to use the commands.

## OpenAI Setup
## Setup

In order to use this repository with GPT 3.5, you need an OpenAI API key.

Expand All @@ -35,6 +35,10 @@ os.environ["OPENAI_API_KEY"] = "YOUR-KEY-HERE"

The OpenAI API that is used in this repo, through which you make queries to GPT 3.5 (the model used for ChatGPT), is not free. However it is extremely cheap and unless you are frequently processing large amounts of text, it will likely cost less than $1 per month. Most months I have spent less than $0.50

## Configuration

If you want to change any configuration settings copy the example configuration file from `GPT/gpt-talon.settings.example` to `GPT/gpt-talon.settings`, which is a .git ignored file and modify anything that you want to change.

## Local Models (llamafiles)

You can use this repository with a [llamafile](https://github.com/Mozilla-Ocho/llamafile). Set the value `user.llm_provider = "LOCAL_LLAMA"` in `gpt-settings.talon` to change the default model.
Expand All @@ -46,9 +50,3 @@ These models are easy to install and run entirely offline. They can be downloade
```

Keep in mind that running a model in the background is resource intensive and it will be slow unless you have a GPU on your computer.

## TODO

- Create prompts that take in arguments from voice commands.
- Make the the help menu less verbose.
- Support openai vision model