Update README.md

This commit is contained in:
Martin 2025-03-10 14:41:07 +01:00 committed by GitHub
parent 96f4faa908
commit 8ed5fa7a35
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -24,7 +24,7 @@
---
## Run locally
## Run locally on your machine
**We recommend using at least Deepseek 14B, smaller models struggle with tool use and forget quickly the context.**
@ -67,6 +67,8 @@ python3 main.py
## **Alternative: Run the LLM on your own server**
If you have a powerful computer or a server that you can use, but you want to use it from your laptop you have the options to run the LLM on a remote server.
### 1**Set up and start the server scripts**
On your "server" that will run the AI model, get the ip address
@ -104,6 +106,26 @@ Run the assistant:
python3 main.py
```
## **Run with an API**
Clone the repository.
Set the desired provider in the `config.ini`
```sh
[MAIN]
is_local = False
provider_name = openai
provider_model = gpt4-o
provider_server_address = 127.0.0.1:5000 # can be set to anything, not used
```
Run the assistant:
```sh
python3 main.py
```
## Providers
The table below show the available providers: