Skip to content

docs: document POST /models/reload under model management #11656

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

Closed
pos-ei-don wants to merge 1 commit into from
Closed

docs: document POST /models/reload under model management #11656

Show file tree
Hide file tree
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
19 changes: 19 additions & 0 deletions docs/content/advanced/advanced-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,25 @@ curl --location 'http://localhost:8080/models/apply' \
```


### Reloading model configurations at runtime

If you add or edit a model YAML file in the models directory while LocalAI is running,
the change is not picked up automatically. Ask LocalAI to re-read the models directory:

```bash
curl -X POST http://localhost:8080/models/reload
# {"success":true,"message":"Model configurations reloaded successfully"}
```

Unlike `/models/apply` above, this does not download anything — it only re-reads
configuration that is already present on disk.

{{% alert note %}}
Reloading is additive: it adds new configurations and replaces existing ones with the
same name, but it does **not** drop configurations whose file has been deleted. A model
whose YAML you removed stays listed in `/v1/models` until LocalAI is restarted.
{{% /alert %}}

### Preloading models during startup

In order to allow the API to start-up with all the needed model on the first-start, the model gallery files can be used during startup.
Expand Down
1 change: 1 addition & 0 deletions docs/content/advanced/model-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ When using `--models-config-file`, you can define multiple models as a list:
| `backend` | string | Backend to use (e.g. `llama-cpp`, `vllm`, `diffusers`, `whisper`) | `llama-cpp` |
| `description` | string | Human-readable description of the model | `A conversational AI model` |
| `usage` | string | Usage instructions or notes | `Best for general conversation` |
| `alias` | string | Redirects this name to another model. See [Model Aliases]({{%relref "features/model-aliases" %}}). | `my-llama-3` |

### Model File and Downloads

Expand Down