Skip to content

Latest commit

 

History

History
410 lines (331 loc) · 19.4 KB

File metadata and controls

410 lines (331 loc) · 19.4 KB

serve — the OpenAI-compatible server

make libwaste.dylib          # or libwaste.so on Linux
python3 -m serve ~/models/k3.waste --port 8000
curl localhost:8000/v1/chat/completions \
  -H 'Content-Type: application/json' \
  -d '{"model":"k3","messages":[{"role":"user","content":"Why is the sky blue?"}]}'

Stdlib only. No package index, no virtualenv, no framework: a server that needs a dependency resolver to start is one more thing between a downloaded model and an answer.

Why Python, and why ctypes

waste.h opens by saying the engine is a library first and the CLI is one of its clients. This is the second client. It does not reimplement any inference — every model operation is a call into libwaste through ctypes, and serve/engine.py mirrors the header struct for struct.

What is left for Python is everything that is not arithmetic: K3's prompt format, the parser that reads its replies back, request validation, SSE framing. That code changes with the OpenAI API and with each model's chat format, neither of which belongs in a C engine that is trying to stay small and dependency-free.

What the model actually needs

Kimi K3 ships no Jinja template. It builds prompts with a Python program, encoding_k3.py, which emits a token sequence directly in XTML — an XML-like markup whose angle brackets are reserved tokens:

in this repo token role
[open] <|open|> starts a tag
[sep] <|sep|> ends a tag header
[close] <|close|> starts a closing tag
[end_of_msg] <|end_of_msg|> ends a message

A turn:

<|open|>message role="user"<|sep|>What is the weather?<|close|>message<|sep|><|end_of_msg|>

and the model is handed the floor with an unclosed assistant message:

<|open|>message role="assistant"<|sep|><|open|>think<|sep|>

examples/chat-k3.json covers the text conversation in four prefix/suffix strings, which is all the C CLI can carry. It explicitly does not cover tool definitions, tool results, JSON schemas, the think channel, or parsing the reply back. Those are what serve/ adds.

serve/xtml.py — the prompt

A port of encoding_k3.py, checked against it. It renders:

  • tool declarations — a system message carrying compact JSON Schema, with a separate lazy-loading variant for tools introduced mid-conversation
  • tool callscall elements with typed argument children (string, number, boolean, null, object, array), or a raw json element when the model's arguments did not parse
  • tool resultsmessage role="tool" numbered by position, with out-of-order OpenAI tool_call_id results re-sorted to match the calls
  • response_formatjson_object and json_schema, injected as synthetic system messages, since K3 has no request field for them
  • tool_choicerequired and none, likewise
  • the think channel, and thinking_effort
  • images<|media_begin|>image WxH<|media_content|><|media_pad|><|media_end|>

It returns segments, not a string:

Segment('<|open|>', markup=True), Segment('message', markup=False), ...

because the two halves go to different tokenizer entry points — waste_tokenize_markup for structure, waste_tokenize for anything a user, document or tool wrote. That is what stops pasted text from closing a turn or opening a forged system message. Upstream draws the same line with allowed_special against disallowed_special.

Two rules in tokenize_segments are load-bearing and easy to "optimize" into bugs:

  1. Never concatenate a prompt and encode it once. That hands whoever wrote the content the ability to write the structure.
  2. Never merge adjacent same-mode segments either. Upstream encodes one segment at a time, and BPE is not associative: role + =" + user encoded apart is a different token sequence than role="user" encoded whole. Merging is a cheap win and a wrong prompt. tests/serve/test_engine.py::test_segments_are_encoded_separately demonstrates the difference on a real tokenizer.

serve/regions.py — the reply

The half encoding_k3.py does not have. It reads the model's XTML back into reasoning_content, content and OpenAI tool_calls, incrementally, so SSE deltas can go out while the model is still talking.

There are two ways to feed it, and they are not equally good:

  • feed_token(id, piece) — what the server uses. Structure is decided by the token id the engine reports. A model that writes the characters <|sep|> — because a user asked what the markup looks like — emits ordinary text tokens, and the element stays open. This is the output-side twin of the tokenize/tokenize_markup split.
  • feed(text) — for hosts that only have text. It finds markers by scanning, so it cannot tell a real <|sep|> from one the model spelled out.

Malformed output is expected, not exceptional: an unterminated element, a <|close|> for something never opened, a reply cut off mid-marker by the token limit. Every one ends as text or a dropped element. A truncated answer beats no answer.

serve/chatfmt.py — containers that are not K3

XTML is not the only format any more, but it is the only complete one. At startup the server asks for the richer format first and falls back:

  1. XTML, if the container's tokenizer carries <|open|>, <|sep|>, <|close|> and <|end_of_msg|> as single tokens. Channels, tools, images — everything below in this document.
  2. The container's own chat.json, otherwise. The same strings waste chat reads, so a container is addressed identically over HTTP and on the command line, and a hand-edited chat.json is honoured by both. Kimi-Linear and GLM-5.3-Flash are served this way.
chat     from ~/models/kimi-linear.waste/chat.json — plain conversation, no reasoning channel,
         no images, native tools
chat     from ~/models/glm53.waste/chat.json — plain conversation, a reasoning channel,
         images, no tools

The three capabilities are read from the container, never assumed: the channel and the images from chat.json, the tools from whether the tokenizer carries all five of Kimi's native tool-call markers as single tokens. Kimi-Linear does; GLM does not, and is refused by name.

That last one is a rendering chat.json itself cannot describe — four prefix/suffix strings say nothing about a tool declaration or an argument list — so the protocol lives in serve/kimitools.py, its own module beside xtml.py, and is enabled only when the whole marker set resolves.

The split is by subject rather than by size. Whether a container can do tools is a fact about its chat.json and its tokenizer, so chatfmt.py decides it and refuses with ChatFormatError. How a tool call is spelled is a fact about the protocol, so kimitools.py owns it and a malformed one raises KimiToolError — the same shape xtml.py has with XTMLError, and api.py maps each to a 400. Nothing in kimitools.py imports chatfmt, which is what lets chatfmt import it. It is Kimi K2's, and it is checked against K2's own published chat_template.jinja rather than transcribed from memory: tests/serve/test_chatfmt_upstream.py, which tests/run.sh runs whenever K2_DIR names a release directory, the same discipline test_xtml.TestAgainstUpstream applies to K3 with K3_DIR. Kimi-Linear's own release carries the five tokens and no chat template at all, which is why the grammar has to come from K2 and why an oracle for it matters more than usual.

One difference from that template is deliberate and asserted rather than fixed: with no system turn first, K2's template inserts Moonshot's own system prompt. A server rendering an arbitrary container's chat.json has no business inventing that.

Plain conversation otherwise means plain: system / user / assistant turns, blocking and streaming. Everything the format cannot express is refused with a 400 that names the field — tools on a container without the markers, an image part on a format with no image block. None of it is silently dropped; a server that ignores reasoning_effort reports a different amount of reasoning than it did.

Three of the fields exist because GLM's format cannot be written without them, and each is optional and absent on both Kimi formats:

field what it is for
prelude emitted once before the first turn, belonging to no role — GLM's is [gMASK]<sop>
stop what ends a generated turn, for a format where that is not the assistant suffix
think the reasoning channel's [open, close] pair
effort how the format asks for a reasoning effort, e.g. "<|system|>Reasoning Effort: {}"
image the block one image expands into, holding exactly one placeholder

stop is the one that fails quietly without it. A GLM turn ends because the next role marker begins — <|assistant|>answer then <|user|>question — so there is no suffix to close it with and the history must not carry one. Taking the stop from the assistant suffix, as every Kimi format wants, left the reply running into the next turn and answering questions nobody had asked.

think is what makes reasoning_content possible from a chat.json container: the reply reader splits on the close marker, so the model's scratch work comes back beside the answer rather than as the answer. A container whose specials carry no think markup still refuses a request that asks for one. A container whose format always opens the channel — GLM's does, and its template has no path that does not — refuses thinking: false for the same reason: answering with the channel closed puts a stray close marker in the reply.

chat.json is validated more strictly here than by the CLI's reader, which has a person watching and an interrupt key. Serving needs an open, a user turn, and an assistant suffix containing a control token — without the last one every reply runs to max_tokens and reports finish_reason: "length", which reads as a broken model rather than a broken template. And every <|…|> in the file is resolved against the real vocabulary: markup the tokenizer does not have encodes as ordinary text, so the model would read its own turn structure as prose and answer anyway, plausibly and wrongly. That check is the reason this path is safe at all, and it is the same reasoning as the tokenize/tokenize_markup split — as is the rendering, where the template's strings go out as markup segments and the caller's content never does.

A container with neither format still starts and still serves /health, /v1/models and /v1/completions; only /v1/chat/completions returns 400, with code: "unsupported_chat_format" and both reasons — no XTML markers, and what was wrong with the chat.json. Resolving used to raise out of the constructor, which took down four working endpoints to report one broken one.

Tool calls over chat.json remain unbuilt: four strings cannot carry a tool declaration, and the markup Kimi-Linear's tokenizer does have for it is not transcribed in this repo. That is what is left of #34.

HTTP

endpoint notes
GET /health liveness; never requires the API key
GET /v1/models, GET /v1/models/{id} reports the container's real shape under a waste key
POST /v1/chat/completions streaming and not, tools, images
POST /v1/completions raw continuation, no chat template

Supported request fields: messages, tools, tool_choice, response_format, temperature, top_p, top_k, seed, max_tokens / max_completion_tokens, stop, stream, stream_options.include_usage, reasoning_effort.

Responses carry an extra waste object with the numbers that actually matter for an expert-streaming engine — hit rate, bytes read, whether the page cache was bypassed — because the OpenAI schema has nowhere to put them.

reasoning_effort

K3's encoder accepts low, high, max. Its own system message advertises a fourth value, medium, and its assert then rejects it; the port reproduces the refusal rather than the documentation, and the server returns a 400 that says so instead of quietly substituting high.

none, minimal and off turn the think channel off entirely.

The default is thinking on, which is what the model was trained for. The technical report measures reasoning at up to 73% of the tokens in a request, and at this engine's speeds that is a long wait before the first word of the answer. --no-thinking flips the default; a request can override either way.

Statelessness

Each HTTP request resets the engine's conversation state before it is prefilled. A waste_ctx keeps its KDA state and MLA KV across calls — that is what makes waste chat a conversation — and carrying that into a stateless server means request N is prefilled on top of request N-1: the same request gets different answers depending on what came before, and one client's turn conditions another's. The lock spans prompt building and generation, so the image queue cannot be crossed between requests either.

Concurrency

waste.h: a waste_ctx is not thread-safe. So generations serialize on one lock, and requests queue. On a model streaming experts off an SSD at a few tokens a second, the wait for the lock is small next to the wait for the answer.

Streaming is written straight from the token callback, on the thread holding the lock. A client hanging up propagates back as a return value the engine understands — the callback says stop, waste_generate unwinds, the next request starts. A disconnected client stops costing tokens immediately, which on a model this slow is the difference between a wasted minute and a wasted hour.

Images

--vision loads the tower (434 MB of weights on K3, and 1.12 GB reserved once the bounded source decode, the tower's activations and the queued image embeddings are counted — out of the same budget the expert cache draws on). Images arrive as base64 data: URLs.

http:// and https:// URLs are not fetched. Doing so would make the server issue requests to addresses its clients choose, which is a server-side request forgery in any deployment where the server can reach more of the network than the client can. Local filesystem paths are off by default too, behind --allow-local-images, since they let any client read files the server can reach.

Open-WebUI

Point it at http://<host>:8000/v1 — with the /v1, since /v1/models is how the client discovers what to put in its model list.

There is no compatibility mode to turn on. Open-WebUI probes GET /v1/models, then streams POST /v1/chat/completions, and it sends a bearer token whether or not one is configured — accepted when --api-key is unset. Fields it sends that this server has no notion of (frequency_penalty, presence_penalty, user) are ignored rather than refused: validation checks the fields it knows and leaves the rest alone, because a 400 for an unrecognised sampling knob makes a working client look broken.

Four things are worth setting before the first message.

--max-tokens. Open-WebUI does not send max_tokens unless you set it in the model's advanced parameters, so every reply stops at the server default — 4096, and worth raising for a model asked to write at length, since a reply that ends at the cap reads as a truncated model rather than a hit limit. Raising --ctx does not help and cannot: context only ever lowers the cap, to the room left after the prompt.

--host. The default 127.0.0.1 is loopback on the machine running the server; Open-WebUI in a container is not on it, and needs --host 0.0.0.0 — and then --api-key, per Security below.

Open-WebUI's task model. It issues background requests for the conversation title, tags and follow-up suggestions on top of the chat itself. Those queue behind the reply on the lock every generation takes, so naming the conversation costs a whole generation at this engine's speeds, and the client may time it out while the answer it is waiting for is still streaming. Turn them off in its admin settings, or point its task model at a smaller backend.

The think channel. Reasoning comes back as reasoning_content, on the message and on each SSE delta. A client that does not know that field shows nothing while the model reasons — which, on a model whose reasoning can be most of the reply, looks like a server that has stopped. --no-thinking makes the default answer-only, and a request can still ask for reasoning.

Security

  • --host defaults to 127.0.0.1. Binding anywhere else without --api-key prints a warning.
  • --api-key (or $WASTE_API_KEY) requires a bearer token, compared in constant time.
  • Request bodies are capped at 64 MB, refused on the declared Content-Length before anything is read.
  • Prompt injection through message content is structurally prevented, not filtered: content never reaches the markup tokenizer. Checked end to end in test_server.py and against the real tokenizer in test_integration.py.

Tests

make serve-check                                  # everything
K3_DIR=/Volumes/WasteDisk/k3 make serve-check     # plus the differential

Six suites, in order of what they prove:

file what it checks needs
test_xtml.py every corpus case rendered segment for segment against the release's own encoding_k3.py, plus frozen goldens the release, for the differential
test_regions.py round trip: anything the encoder can express, the parser reads back; every chunk split; malformed output
test_chatfmt.py the chat.json path: the templates examples/ ships, everything the format refuses by name, and markup the tokenizer lacks refused at load
test_engine.py the ctypes binding against a real engine and a synthetic container libwaste
test_server.py HTTP over real sockets against a scripted engine
test_integration.py the whole stack, no fakes libwaste

The goldens in tests/serve/fixtures/ record whether the release was present when they were generated. Goldens produced by our own renderer would lock in whatever it currently does, bugs included, so test_goldens_were_generated_from_upstream fails rather than let that pass as evidence.

Regenerate them on a machine that has the weights:

K3_DIR=/Volumes/WasteDisk/k3 python3 tools/gen_xtml_goldens.py

Flags

python3 -m serve MODEL [options]

  --host, --port, --model-id, --api-key
  --budget SIZE      hard RAM ceiling, e.g. 48G (0 = the engine chooses)
  --ctx N            context tokens
  --threads N        compute threads (0 = one per core)
  --cpus LIST        restrict them to a cpu list, e.g. 0-5 or 0-2,6-8;
                     --threads 0 then means one per CPU listed. Linux and
                     Windows — see docs/ENGINE.md, "Thread placement"
  --cache {lfru,lru} expert-cache eviction policy
  --no-direct-io     keep the page cache in the way (the bypass is on)
  --vision           load the vision tower
  --verify           check every expert record's crc32 as it is read
  --usage PATH       learned hotlist (default <model>/usage.waste)
  --exclusive-open    ask for POSIX single-process container ownership
  --max-tokens N     default cap when a request does not set one (4096)
  --no-thinking      answer without the think channel unless asked
  --allow-local-images
  --plan             print the memory plan and exit