Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/syn54x/whisper
Whisper 🤫 sweet nothin's to your favorite LLM.
https://github.com/syn54x/whisper
assistant-chat-bots cli generative-ai llm python
Last synced: 2 months ago
JSON representation
Whisper 🤫 sweet nothin's to your favorite LLM.
- Host: GitHub
- URL: https://github.com/syn54x/whisper
- Owner: syn54x
- License: apache-2.0
- Created: 2024-09-30T22:52:31.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T03:03:52.000Z (3 months ago)
- Last Synced: 2024-10-26T16:21:45.802Z (3 months ago)
- Topics: assistant-chat-bots, cli, generative-ai, llm, python
- Language: Python
- Homepage: https://syn54x.github.io/whisper/
- Size: 1.66 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `whisper` 🤫
[Visit the docs](https://syn54x.github.io/whisper/)
[](https://codecov.io/gh/syn54x/whisper)
[](https://opensource.org/licenses/Apache-2.0)
## Supported Models
| Provider Name | Supported by Whisper | Config Key |
|------------------------------|----------------------|------------|
| GPT4All | ✅ | gpt4all |
| ChatAnthropic | ✅ | anthropic |
| ChatMistralAI | ✅ | mistral |
| ChatFireworks | ✅ | fireworks |
| AzureChatOpenAI | ✅ | azureopenai|
| ChatOpenAI | ✅ | openai |
| ChatTogether | ❌ | |
| ChatVertexAI | ❌ | |
| ChatGoogleGenerativeAI | ❌ | |
| ChatGroq | ❌ | |
| ChatCohere | ❌ | |
| ChatBedrock | ❌ | |
| ChatHuggingFace | ❌ | |
| ChatNVIDIA | ❌ | |
| ChatOllama | ❌ | |
| ChatLlamaCpp | ❌ | |
| ChatAI21 | ❌ | |
| ChatUpstage | ❌ | |
| ChatDatabricks | ❌ | |
## Install
To install Whisper, you can use pip:
```console
pipx install just-whisper
```
## Setup
After installing Whisper, you need to initialize the configuration for Whisper. This involves setting up API keys for the services you intend to use, such as OpenAI or Anthropic.
To initialize the configuration, run:
```console
$ whisper init
```
This will create a basic configuration file in your home directory (`~/.whisper/whisper.toml`). You should update this file with your API keys.
### Setup with keys
If you have keys for OpenAI or Anthropic handy, you can initialize the configuration with:
```console
$ whisper init --openai-key --anthropic-key
```
## Config
The whisper config file is located at `~/.whisper/whisper.toml`. It looks like this:
```toml
# ~/.whisper/whisper.toml
default = "openai"
[openai]
api_key = "sk-proj-..."
model = "gpt-3.5-turbo"
[anthropic]
api_key = "sk-ant-..."
model = "claude-3-opus-20240229"
```
### Config Management
You can manage your config files using the `whisper config` command. For example...
#### Show Config
```bash
❯ whisper config show
UserConfig(
│ default='openai',
│ openai=OpenAIConfig(api_key='replace-me', model='gpt-3.5-turbo'),
│ anthropic=AnthropicConfig(api_key='replace-me', model='claude-3-5-sonnet-20240620')
)
```
#### Get A Config Value
```bash
❯ whisper config get openai.model
gpt-3.5-turbo
```
#### Set A Config Value
```bash
❯ whisper config set openai.api_key "sk-proj-..."
UserConfig(
│ default='openai',
│ openai=OpenAIConfig(api_key='sk-proj-...', model='gpt-3.5-turbo'),
│ anthropic=AnthropicConfig(api_key='replace-me', model='claude-3-5-sonnet-20240620')
)
```
# Support Me :)
If you found this project helpful, please consider supporting me by buying me a coffee.
[PayPal.Me](https://paypal.me/syn54x?country.x=US&locale.x=en_US)
ETH: `0x329941cDc2D84ddDf3c0b9dB9791bc787e64AE4E`
BTC: `3AVY6ySYGVJJHFo3ebrNYx9oSmqShLYrz8`