Skip to content

Commit c4c6e4b

Browse files
committed
docs: restore inference engine overview
1 parent 045e69f commit c4c6e4b

2 files changed

Lines changed: 32 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ uses [Semantic Versioning](https://semver.org/).
55

66
## [Unreleased]
77

8+
### Documentation
9+
10+
- Restored a visible README overview of Olla, oMLX, llama.cpp, Ollama, and
11+
LiteLLM compatibility while retaining the detailed compatibility guide.
12+
813
## [0.3.0] - 2026-07-15
914

1015
### Added

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,33 @@ the `X-Olla-Endpoint`, `X-Olla-Sticky-Session`, and
141141
`X-Olla-Sticky-Key-Source` response headers. Never publish full session keys,
142142
provider credentials, private endpoints, or the HMAC key.
143143

144+
## Inference engines and gateways
145+
146+
The plugin is engine-agnostic: it adds a computed request header, while the
147+
receiving gateway or router defines what that header means. Relevant setups
148+
include:
149+
150+
- **[Olla](https://github.com/thushan/olla)** — the tested sticky-session
151+
gateway recipe. Olla consumes the session header and owns backend affinity,
152+
repinning, TTL, and routing observability.
153+
- **[oMLX](https://github.com/jundot/omlx)** — an OpenAI-compatible inference
154+
server. A direct single-server deployment does not need affinity; use the
155+
plugin when an external router in front of multiple oMLX servers consumes the
156+
header.
157+
- **[llama.cpp](https://github.com/ggml-org/llama.cpp)** — provides
158+
OpenAI-compatible endpoints, parallel slots, prompt reuse, and a multi-model
159+
router, but does not define a native header for session affinity. Put that
160+
contract in an external gateway.
161+
- **[Ollama](https://github.com/ollama/ollama)** — provides OpenAI-compatible
162+
endpoints but no documented header-based affinity. Its `keep_alive` request
163+
option controls model residency, not request routing.
164+
- **[LiteLLM](https://github.com/BerriAI/litellm)** — can forward client `x-*`
165+
headers, but a forwarded session header is not automatically sticky. Pair it
166+
with a router or hook that explicitly implements the header semantics.
167+
168+
See [docs/compatibility.md](docs/compatibility.md) for the detailed limitations,
169+
configuration guidance, and upstream references for each setup.
170+
144171
## Requirements and compatibility
145172

146173
- Hermes Agent 0.18.2 or newer with user plugins and `llm_request` middleware.
@@ -159,9 +186,6 @@ Middleware only covers the main conversation request path. Model discovery,
159186
probes, MoA reference clients, auxiliary inference, and provider authentication
160187
that bypass `llm_request` remain outside scope.
161188

162-
See [docs/compatibility.md](docs/compatibility.md) for oMLX, llama.cpp, Ollama,
163-
LiteLLM, and gateway-specific guidance.
164-
165189
## Update and rollback
166190

167191
Before updating from 0.2.x:

0 commit comments

Comments
 (0)