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.

Sign up for GitHub

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

add list of supported models to README #68

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add list of supported models to README #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ Once started you can find use the following URLs:
- bee-api: http://localhost:4000 (for direct use of the api, use apiKey `sk-testkey`)
- list all open ports: `docker compose ps --format "{{.Names}}: {{.Ports}}"`

## Supported providers

- Watsonx: [supported models](https://github.com/i-am-bee/bee-agent-framework/blob/main/src/adapters/watsonx/chatPreset.ts), optimized for `meta-llama/llama-3-1-70b-instruct`
- Ollama: any chat model, optimized for `llama3.1`
- OpenAI: any chat model, `gpt4o` performs best
- BAM (deprecated): [supported models](https://github.com/i-am-bee/bee-agent-framework/blob/main/src/adapters/bam/chatPreset.ts), optimized for `meta-llama/llama-3-1-70b-instruct`
Copy link
Contributor

Choose a reason for hiding this comment

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

since BAM is internal only (right?) and deprecated, I wonder if we should omit that one from the list of supported providers ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, BAM has even been removed from the framework


## ⛓️‍💥 Troubleshooting
Please see our [troubleshoting guide](docs/troubleshooting.md) for help with the most common issues.

Expand Down