Skip to content

Add warning regarding function calling and self-hosted models #6

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

Merged
pavangudiwada merged 3 commits into from
May 31, 2024
Merged

Add warning regarding function calling and self-hosted models #6

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e418e31
Add warning regarding function calling and self-hosted models
aantn May 31, 2024
92ba710
Update README.md
aantn May 31, 2024
e246b2f
Update README.md
aantn May 31, 2024
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,14 @@ holmes ask "what pods are unhealthy and why?" --llm=azure --api-key=<PLACEHOLDER
</details>

<details>
<summary>Using a self-hosted LLM like llama 3</summary>
<summary>Using a self-hosted LLM</summary>

You will need an LLM with support for function-calling (tool-calling). To use it, set the OPENAI_BASE_URL environment variable and run `holmes` with a relevant model name set using `--model`.

**Important: Please verify that your model and inference server support function calling! HolmesGPT is currently unable to check if the LLM it was given supports function-calling or not. Some models that lack function-calling capabilities will hallucinate answers instead of reporting that they are unable to call functions. This behaviour depends on the model.**

In particular, note that [vLLM does yet support function calling](https://github.com/vllm-project/vllm/issues/1869), whereas [llama-cpp does support it](https://github.com/abetlen/llama-cpp-python?tab=readme-ov-file#function-calling).

You will need an LLM with support for tool-calling. To use it, set the OPENAI_BASE_URL environment variable and run `holmes` with a relevant model name set using `--model`.
</details>

## More Examples
Expand Down