Compare commits
No files matched your search
+179
-1
@@ -1126,7 +1126,8 @@ EU-safe textured path — its ComfyUI node and VRAM need are to be
|
||||
checked), **Direct3D-S2** (MIT, DreamTech; high-detail shape, has a
|
||||
ComfyUI node) if TRELLIS.2's detail falls short. Not in: TripoSR and
|
||||
InstantMesh (permissive but superseded), Stable Fast 3D (Stability's
|
||||
community licence, revenue-capped), SAM 3D Objects (Meta's own licence,
|
||||
community licence, revenue-capped; served all the same since 2026-10-10
|
||||
at the user's request, see G3), SAM 3D Objects (Meta's own licence,
|
||||
to be read before it is considered). Steam's disclosure form (changed
|
||||
2026-01-16) lists pre-generated 3D models as content that must be
|
||||
declared on the store page: the licence notice G3 writes into the GLB is
|
||||
@@ -1201,6 +1202,23 @@ newer). TripoSR (MIT) proves the chain on cuda01: a .glb from a picture
|
||||
in about 30 s. Left: background removal before TripoSR (BiRefNet, MIT,
|
||||
as a node), TRELLIS.2 or Direct3D-S2 on an Ampere card with an ungated
|
||||
encoder, a missing node refusing the replica by name.
|
||||
Added 2026-10-10 at the user's request, beside the order above: **Stable
|
||||
Fast 3D** as `sf3d` (Stability AI Community License: free under US$1 M
|
||||
annual revenue, an enterprise licence above, "Powered by Stability AI"),
|
||||
the textured mesh that runs on Turing: about 1 s a mesh warm in fp16,
|
||||
UV-mapped GLB with its texture, 18 GB of the card at peak. Its weights are
|
||||
gated, so they were fetched once with the user's token into
|
||||
/srv/llmgw-comfy/stable-fast-3d and linked into the engine user's
|
||||
Hugging Face cache, which its loader node reads by repository name; no
|
||||
token is on the machine at runtime. Its own save node returns the GLB as
|
||||
base64, which the gate cannot fetch, so `LLMGWSaveMesh` writes the file;
|
||||
`LLMGWPrepareForMesh` now also gives the object's mask. Left: its two
|
||||
CUDA extensions (texture_baker, uv_unwrapper) are not on PyPI, so they
|
||||
were built on cuda01 and installed into the engine's venv by hand; a
|
||||
custom node's requirements need a way to name a local build, or the
|
||||
engine install must carry them, before a customer site gets this. And
|
||||
rembg's default session now fetches BRIA RMBG-2.0 (non-commercial):
|
||||
every workflow must name its rembg model (ours say u2net).
|
||||
- Catalog: a model makes `pictures` or `meshes` (`MakesImages` becomes an
|
||||
output kind; `ServesComfyUI` stays). 3D weight folders in the gate's
|
||||
`modelFolders`; the workflow's placeholders gain `image` (the input
|
||||
@@ -1252,6 +1270,166 @@ the .glb, a viewer with `<model-viewer>` from the allowed CDNs), `ctl
|
||||
jobs list|get|cancel`, the console's Jobs view. The page sends down the
|
||||
same path as the API, like `imagesSend` does.
|
||||
|
||||
## H. ComfyUI as a platform (written 2026-10-11)
|
||||
|
||||
G made one model at a time work: flux for pictures, TripoSR and SF3D for
|
||||
meshes, each with its own endpoint, its own request shape and its own
|
||||
replica. The user's direction (2026-10-11): llmgw is a generic platform,
|
||||
and should serve whatever ComfyUI can run — pictures, edits, video,
|
||||
audio, meshes, upscaling, segmentation — as data in the catalog rather
|
||||
than code per model. Two decisions shape everything below:
|
||||
|
||||
- **The licence is metadata, not a filter.** llmgw does not leave a
|
||||
model out because of its licence. The licence travels with the model
|
||||
and with every file it makes; what a site will not serve is that
|
||||
site's policy (H6). The game studio's EU constraint is one such policy,
|
||||
not a decision the code makes for everyone.
|
||||
- **The install fits the hardware.** The PoC has one Turing card; other
|
||||
sites will have Ampere, Ada and Hopper. A catalog entry must be
|
||||
writable once and placed sensibly anywhere: fp16 on Turing, bf16 or
|
||||
fp8 where the card has them, flash-attention models only where it
|
||||
runs, CUDA extensions built for the card that runs them (H2, H4).
|
||||
|
||||
The first set of models proves the structure at its corners rather than
|
||||
by licence: Qwen-Image-Edit (several weight files, two pictures in),
|
||||
Wan 2.2 small (video out, a long job), ACE-Step (audio out), SF3D (a
|
||||
package not on PyPI, gated weights), Hunyuan3D (a licence that excludes
|
||||
the EU, which H6 must be able to say no to).
|
||||
|
||||
### H1. A workflow says what it takes and makes (M) — built 2026-10-11, not yet tried on the PoC
|
||||
Built as written, with three choices: a run answers with one file, the
|
||||
first of its output kind (several outputs as one zip is left); the
|
||||
workflow's placeholders are checked against the inputs when a run is
|
||||
served, since the catalog never reads the workflow file; and video,
|
||||
audio and files count as nothing in usage until a per-run price exists
|
||||
(per_image and per_mesh still count pictures and meshes).
|
||||
- Catalog: `comfyui.inputs` — a list of `{name, type, required, default,
|
||||
min, max, choices, max_mb, doc}`, type one of text, int, float, bool,
|
||||
choice, image, mask, audio, video, file. Each is a placeholder of the
|
||||
same name in the workflow. The template's own placeholders are checked
|
||||
against the list when the catalog is built: one the workflow uses that
|
||||
no input or built-in names is refused there, not at the first request.
|
||||
- `comfyui.output` gains `video`, `audio` and `files` beside `pictures`
|
||||
and `meshes`; `files` takes whatever the workflow saves. `comfy.Image`
|
||||
becomes `comfy.File` and `typeByName` knows mp4, webm, gif, wav, flac,
|
||||
mp3, ogg.
|
||||
- Endpoint: `POST /v1/workflows/runs` with `{model, inputs: {...}}`, a
|
||||
job like G1's (`GET /v1/workflows/runs[/{id}]`, `.../cancel`). A file
|
||||
input is base64, a data URL, or a `file-…` id from `/v1/files` for
|
||||
what is too big to send inline (video, long audio). Files go into the
|
||||
replica's input directory through the gate's `/upload/image`, which
|
||||
ComfyUI uses for any file. `/v1/images/generations` and
|
||||
`/v1/3d/generations` stay as they are, as fixed shapes over the same
|
||||
machinery.
|
||||
- The models list (`/v1/models`) gives each ComfyUI model its inputs and
|
||||
output kind, so a client can build a form without reading the catalog.
|
||||
- Done when: the existing flux, triposr and sf3d entries work unchanged,
|
||||
and one model with a picture and a text input (Qwen-Image-Edit) runs
|
||||
through `/v1/workflows/runs` with a 400 for a missing required input
|
||||
before any job is written.
|
||||
|
||||
### H2. Profiles that fit the hardware (M) — built 2026-10-11
|
||||
Built as written. A profile by need is left out of placement until the
|
||||
cluster's cards are known: with no class, placement would have read it as
|
||||
a CPU profile. A profile's own `source` is loaded under its own file name
|
||||
by the workflow's `{{checkpoint}}`.
|
||||
- A profile may say `gpu: {min_compute_capability, min_memory_gb}` in
|
||||
place of `gpu_class`. When the reconciler places a model, such a
|
||||
profile stands for every GPU class in the cluster that meets it, at
|
||||
the profile's priority: the catalog function that turns profiles into
|
||||
placement's view takes the cluster's classes (class, compute
|
||||
capability, memory) and returns one concrete profile per class that
|
||||
fits, named `<profile>@<class>`. Placement itself is unchanged: it
|
||||
still sees exact classes, and a tensor-parallel group still never
|
||||
mixes them.
|
||||
- A ComfyUI profile may carry its own `comfyui` block (workflow, nodes,
|
||||
checkpoint) over the model's: the fp8 workflow on compute 8.9 and up,
|
||||
the fp16 one on 7.5. A Turing card is not an error, it is the profile
|
||||
that fits it.
|
||||
- Done when: one catalog entry with an "ampere+" profile (min 8.0) and a
|
||||
"turing" fallback places the fallback on cuda01, and the same entry,
|
||||
in a test with an A100 in the inventory, places the other.
|
||||
|
||||
### H3. Environments: which models can share a replica (S, the catalog side)
|
||||
- `comfyui.environment: <name>` puts a model in a named environment.
|
||||
Models in one environment must agree on every custom node they both
|
||||
name (same repository, same commit) and their requirements must
|
||||
resolve together; the catalog refuses an environment that cannot, with
|
||||
both models' names. Models with no environment are each their own, as
|
||||
today.
|
||||
- `Catalog.Environments()` returns each environment with its models and
|
||||
the union of their nodes: what one replica of it must install.
|
||||
- Placement and eviction of a replica that serves every model of its
|
||||
environment (so flux, SF3D and Qwen-Image-Edit stop handing the card to
|
||||
each other with a 30 s cold start each time) is the other session's
|
||||
work (llmgw-b7), built on this.
|
||||
|
||||
### H4. Custom nodes with packages that are built, not downloaded (S) — built 2026-10-11
|
||||
Built as written, with `uv build --no-build-isolation` against ComfyUI's
|
||||
Python, the card's capability asked of torch in the replica (so
|
||||
CUDA_VISIBLE_DEVICES is the card it will run on), and wheels kept under
|
||||
the engines' cache by commit, `sm<arch>` and directory. Also
|
||||
`comfyui.huggingface_repo`: a node that loads its weights by repository
|
||||
name (SF3D's) finds them in the engines' Hugging Face cache, linked by the
|
||||
gate, so no token is on the node.
|
||||
- `nodes[].build: [subdir, ...]`: directories of the node's repository
|
||||
that are Python packages with C++/CUDA extensions (SF3D's texture_baker
|
||||
and uv_unwrapper). The gate builds each as a wheel with the engine's
|
||||
Python, `TORCH_CUDA_ARCH_LIST` set from the compute capability of the
|
||||
card it runs on, and installs it into the replica's own `site` like
|
||||
any other requirement. Built wheels are kept under the engine's home by
|
||||
node commit, subdirectory and architecture, so the second replica on
|
||||
the same kind of card does not build again.
|
||||
- A node needing nvcc on a node without it refuses the replica with that
|
||||
said, not with a compiler's traceback.
|
||||
- Done when: SF3D runs on cuda01 with nothing installed into the engine's
|
||||
venv by hand (the hand install of 2026-10-10 removed first).
|
||||
|
||||
### H5. Licence on every output (S) — done 2026-10-14: the whole licence in GLB asset.extras and PNG iTXt; video and audio not yet
|
||||
- `License` gains `id` (SPDX where there is one, else a lowercase name:
|
||||
stability-community, tencent-hunyuan-community), `commercial` (unset is
|
||||
not said), `excluded_regions` (ISO 3166 codes, `EU` for the union),
|
||||
`revenue_cap_usd` and `attribution` ("Powered by Stability AI"). All
|
||||
optional but the name. Done 2026-10-11 in the catalog, so H6 can match
|
||||
on `id`.
|
||||
- Written into the file where the format has a place for it: glTF
|
||||
`asset.extras.license` (as now), PNG an `iTXt` chunk named `license`
|
||||
(the workflow's own text chunks are still stripped), MP4/WebM and the
|
||||
audio formats in their metadata where ffmpeg is at hand on the router,
|
||||
otherwise beside it in the job's answer only — said in the docs.
|
||||
|
||||
### H6. Licence choices (S) — done 2026-10-11 (4bbac08), live on the PoC
|
||||
The user asked (2026-10-11) for the choice to be a person's: on their
|
||||
profile they pick the licences they will not use, and their keys and
|
||||
portal session neither see those models in `/v1/models` nor may call
|
||||
them (403, saying which licence). Matched on `license.id`, and on
|
||||
`commercial` / `excluded_regions` where a choice is put that way. Its
|
||||
store table is migration 0046. A site-wide or team-wide default can sit
|
||||
on top of it later.
|
||||
|
||||
### H7. A job worker per model, not one for all (S) — done 2026-10-14: one job per model at a time, eight in all
|
||||
The worker runs one job at a time: a job waiting for the card holds up a
|
||||
job for another model that could run now (seen on the PoC, 2026-10-10).
|
||||
Jobs are claimed and run concurrently up to a limit per model (or per
|
||||
environment, after H3) and a cluster-wide cap, with the lease and
|
||||
leader-only rules of G1 kept.
|
||||
|
||||
### H8. Presets that add themselves (S) — done 2026-10-13 (v0.14.5)
|
||||
flux-schnell and triposr come with llmgw (`ctl model add <preset>`), and
|
||||
the leader adds them on demand where a node fits one, the cluster installs
|
||||
ComfyUI and the catalog makes nothing of that kind (`presets.auto`); a
|
||||
preset removed is declined and not added back. The cluster page and the
|
||||
console show and add them.
|
||||
|
||||
### H9. Small things learned on the PoC (2026-10-14)
|
||||
- Done: `albedo_match` on sf3d (its delighting made dark objects light);
|
||||
`on_demand.evict_after_idle` / `min_lifetime` as live settings; an
|
||||
upgrade that leaves nodes behind says which; `ctl model serve` serves an
|
||||
embedding model for embedding; refreshes wait while a form is filled in.
|
||||
- Open: llmgw's `/mcp` with picture, 3D, VLM and workflow tools, so a
|
||||
client needs no server of its own (asked by the game team); the shared
|
||||
ComfyUI replica (H3's placement side).
|
||||
|
||||
## D. Facts worth knowing before starting
|
||||
|
||||
- Admin API: `127.0.0.1:9090`, no auth, `ctlClient` in `internal/cli/ctl.go`.
|
||||
|
||||
+236
-1
@@ -19,13 +19,248 @@ is only released once its **exit criterion** is met, not when its code lands.
|
||||
| v0.12.0 | — | The cluster's settings in the store, in force when changed; the firewall switch; wipe | released |
|
||||
| v0.13.0 | — | The whole system stopped and started from one command; Qwen3Guard judges, on a GPU and CPUs together | released |
|
||||
| v0.14.0 | — | Knowledge bases: documents from people's own machines, kept apart per tenant, answered from | released (v0.14.1: adapters, the tree over the API, the firewall on every machine; v0.14.2: pictures from ComfyUI; v0.14.3: 3D models as jobs) |
|
||||
| v1.0.0 | 5 | Tenancy, prefix affinity, benchmarking | planned |
|
||||
| v1.0.0 | 5 | What phase 5 has left: precise KV routing proven on vLLM, the block cost picker, defragmentation across NVLink domains, prefill/decode disaggregation | planned |
|
||||
|
||||
Until v1.0.0 the minor version is the breaking one: configuration formats and Go
|
||||
APIs change between minors without a deprecation period.
|
||||
|
||||
## Unreleased
|
||||
|
||||
### Added
|
||||
|
||||
- **Pictures uploaded to work from**: `/v1/files` takes `purpose=vision` or
|
||||
`user_data` besides `batch`, kept as long as job results, so a picture is
|
||||
sent once and named by its `file-…` id in the MCP tools and a workflow's
|
||||
inputs.
|
||||
- **One ComfyUI for an environment's models**: ComfyUI models in one
|
||||
`comfyui.environment` (two or more) share one replica — the catalog
|
||||
makes it a hidden entry, `comfyui-env-<name>`, on the first member's
|
||||
profiles with the most memory any member needs, carrying every member's
|
||||
weights and custom nodes. Asking for any member starts it; it answers for
|
||||
each with that member's workflow and checkpoint, and the members get no
|
||||
replicas of their own. A picture model and a 3D model on one card stop
|
||||
handing it to each other with a cold start each way.
|
||||
- **Pictures, 3D models, vision and workflows as MCP tools** at `/mcp`,
|
||||
beside the memory notes, each offered only where the gateway has a model
|
||||
for it: `generate_image` (with `concept`, `side` and `texture` styles),
|
||||
`generate_mesh` (from a picture or a prompt), `review_images` (a vision
|
||||
model, to a JSON schema), `run_workflow`, `job_status` and
|
||||
`gateway_status`. Each makes its request under the caller's key, so
|
||||
allowlists, limits, licences and budgets apply and it is charged like
|
||||
any request; what it makes is kept as the caller's file and answered by
|
||||
id and download URL. A client that takes a stream gets
|
||||
`notifications/progress` while a mesh is made and waits up to ten
|
||||
minutes; one that does not, 50 seconds, then the job id.
|
||||
- **Setup asks where alerts go**: `llmgw server init --webhook URL`
|
||||
(repeatable) and a **Notification webhooks** field on both setup screens.
|
||||
Slack's, Mattermost's and Rocket.Chat's addresses are sent Slack's text,
|
||||
any other the event as JSON (`slack:` or `json:` in front says which).
|
||||
They are added to the cluster's `notify.webhooks` beside those already
|
||||
there, and each is sent a test once the control plane runs on them.
|
||||
|
||||
- **Extended thinking on `/v1/messages`**: `thinking: {type: "enabled"}`
|
||||
tells a model that thinks by its chat template to (`enable_thinking`),
|
||||
and its reasoning comes back as `thinking` blocks before the text,
|
||||
streamed as `thinking_delta` events; `disabled` tells it not to. Not
|
||||
asked for, the reasoning is left out as before.
|
||||
- **How long on-demand models hold a card** is a setting, in force on the
|
||||
leader within seconds: `on_demand.evict_after_idle` (2m unless set) and
|
||||
`on_demand.min_lifetime` (5m). On one card shared by a picture model and
|
||||
a 3D model, 1m each brings the wait between a picture and its mesh to
|
||||
about a minute.
|
||||
|
||||
### Fixed
|
||||
|
||||
- A model whose weights and context pool did not fit its card was added
|
||||
and then failed to make its context on every start, taking the card from
|
||||
others each time (Apertus 70B with a 65536-token pool, 8B with 131072, on
|
||||
24 GB). `ctl model serve` shrinks the pool to what the card holds, saying
|
||||
so, and refuses weights that do not fit at all; the portal's serve form
|
||||
refuses such a pool and says the largest that fits.
|
||||
- Removing weights from the mirror that a catalog model still loads is
|
||||
refused, naming the model: removed from the mirror alone, the model stayed
|
||||
in the catalog and its replicas went on loading the node's copy.
|
||||
- Jobs ran one at a time, so a 3D job waiting for the card held up another
|
||||
model's job that could have run. They run side by side, one per model at
|
||||
a time and eight in all, on the leader as before.
|
||||
- `llmgw ctl model serve` served an embedding model as a chat model: no
|
||||
`--embedding`, four slots, a 512-token batch, `embeddings` unset and a
|
||||
"say hello" smoke test it could not pass. A model whose GGUF says it
|
||||
pools (or `--embeddings`) is served for embedding: 32 slots of 1024
|
||||
tokens unless sized otherwise, a batch that holds a whole passage, and
|
||||
one vector asked for as its smoke test.
|
||||
- `llmgw ctl upgrade` checks every node's version once the waves are done
|
||||
and fails naming any not on the release, and says when the control plane
|
||||
has no nodes registered; `llmgw upgrade` on a control plane says how many
|
||||
nodes it left behind and the command that upgrades them. A site's nodes
|
||||
stayed a release behind with nothing to say so.
|
||||
- The cluster and node pages swapped their live part every few seconds,
|
||||
forms and all, so filling one in raced the clock: what was typed, an
|
||||
open choice and the focus were lost. The refresh now waits while a field
|
||||
in it has the focus or a form in it has been typed into and not sent;
|
||||
the mirror page's reload during a download waits the same way.
|
||||
|
||||
## v0.14.5 — 2026-10-14
|
||||
|
||||
Picture and 3D models that add themselves where a card fits them, with a
|
||||
card on the portal and a screen in the console to see and add them; a
|
||||
mesh's colour brought to the picture it was made from; and the whole
|
||||
licence written into every mesh.
|
||||
|
||||
**Upgrading.**
|
||||
- The store gains a table (migration 0047: preset_state); nothing to do.
|
||||
- **`presets.auto` is on**: once upgraded, the leading control plane adds
|
||||
flux-schnell and triposr, on demand, where a node's card fits one, the
|
||||
cluster installs ComfyUI (`engines.comfyui`) and the catalog makes
|
||||
nothing of that kind. Nothing is fetched until somebody asks for one.
|
||||
Turn it off with `llmgw ctl model presets auto off`.
|
||||
- **Nodes** need this release for `albedo_match` (it is in the save node
|
||||
the gate puts in each replica); a ComfyUI replica takes it when it
|
||||
starts again.
|
||||
|
||||
### Added
|
||||
|
||||
- **A mesh's base colour brought to its picture's**: `LLMGWSaveMesh` takes
|
||||
`albedo_match` with the picture and its mask, and scales the texture in
|
||||
linear light to the object's brightness in the picture. Stable Fast 3D
|
||||
takes the light out of what it sees and read a dark basalt (0.17) as a
|
||||
light stone dimly lit (0.67); matched, it is 0.17. On sf3d it is the
|
||||
`albedo_match` input (off unless asked).
|
||||
- **Picture and 3D models by themselves**: once a node has a card that fits
|
||||
flux-schnell or triposr and the catalog makes nothing of that kind, the
|
||||
leading control plane adds the preset on demand — so a new cluster's
|
||||
portal has its Images and 3D pages without a definition written — where
|
||||
the cluster installs ComfyUI. `presets.auto` turns it off; a preset
|
||||
somebody removes is not added back. `GET /api/v1/presets` says how each
|
||||
stands and why one is not added; `POST /api/v1/presets/{name}` adds one
|
||||
(and sets `engines.comfyui` if the cluster has none); `PUT
|
||||
/api/v1/presets/auto`. Each automatic addition is in the audit log.
|
||||
- **Presets on the portal and in the console**: the cluster page's
|
||||
**Pictures and 3D models** card lists each preset — what it makes, the
|
||||
classes it fits here, whether and by whom it was added, why the leader
|
||||
has not — with an **Add** button that says first when it would install
|
||||
ComfyUI and restart the control planes, and the switch for `presets.auto`.
|
||||
The console's models screen shows the same; **A** adds one, **P** flips
|
||||
the switch. `ctl model add PRESET` and `ctl model presets` go through the
|
||||
API (and `ctl model presets auto on|off`), falling back to the entry as
|
||||
v0.14.4 sent it on an older control plane.
|
||||
|
||||
### Fixed
|
||||
|
||||
- A mesh carried only its licence's name, URL and notice; it carries the
|
||||
whole licence as `/v1/models` gives it — id, commercial use, excluded
|
||||
regions, revenue cap, attribution — for a pipeline that sorts assets by
|
||||
licence.
|
||||
- A workflow's `{{name|false}}` default filled a BOOLEAN input with the
|
||||
word rather than a boolean.
|
||||
|
||||
|
||||
## v0.14.4 — 2026-10-13
|
||||
|
||||
Any ComfyUI workflow as a job, with typed inputs; picture and 3D models
|
||||
added by name; profiles that fit whatever card a site has, and ComfyUI on
|
||||
a V100; licences a machine can match and a person can leave out; a job
|
||||
waiting for the one card says what holds it. Many fixes to on-demand
|
||||
models taking turns on one card.
|
||||
|
||||
**Upgrading.**
|
||||
- The store gains a table (migration 0046: user_excluded_licences);
|
||||
nothing to do.
|
||||
- **Nodes** need this release for ComfyUI on Volta or Pascal cards (the
|
||||
cu126 build), for a driver from NVIDIA's open kernel module to be read,
|
||||
and for a node that loads its weights by repository name (sf3d); a
|
||||
ComfyUI already installed is kept.
|
||||
- **Control planes before nodes**: an entry using the built-in `triposr`
|
||||
workflow, or a `gpu:` need instead of a class, is refused by an older
|
||||
control plane.
|
||||
- Models added with `llmgw ctl model add <preset>` take the preset's name;
|
||||
remove an entry of that name first.
|
||||
|
||||
### Added
|
||||
|
||||
- **The client API described**: OpenAPI 3.1 at `/v1/openapi.json`, no key
|
||||
needed, generated from a route table a test holds to the router's own;
|
||||
and `/docs/api`, Swagger UI (served from the gateway) over it and, for
|
||||
staff, over the admin API's document.
|
||||
- **A job waiting for the card says so**: `progress` is
|
||||
`{"state":"waiting_gpu","held_by":…,"eta_seconds":…}` while another
|
||||
on-demand model holds it; a direct request's 503 carries
|
||||
`X-Llmgw-Waiting-For` and `X-Llmgw-Eta-Seconds`.
|
||||
- **Any ComfyUI workflow, as a job**: `POST /v1/workflows/runs` with
|
||||
`{model, inputs}`. A model's catalog entry declares its inputs
|
||||
(`comfyui.inputs`: text, int, float, bool, choice, image, mask, audio,
|
||||
video, file, with bounds and defaults) and its output (`comfyui.output`:
|
||||
pictures, meshes, video, audio or files); a request is checked against
|
||||
them before a job is written, file inputs are base64, a data URL or a
|
||||
`/v1/files` id, and `/v1/models` lists each model's `workflow` so a
|
||||
client can build its form. A PNG result carries the licence in an
|
||||
`iTXt` chunk, a GLB in `asset.extras` as before.
|
||||
- **Environments**: `comfyui.environment` names ComfyUI models that agree
|
||||
on their custom nodes and may share one replica; the catalog refuses
|
||||
one that cannot.
|
||||
- **Profiles that fit the hardware**: a profile may say `gpu:
|
||||
{min_compute_capability, min_memory_gb}` instead of `gpu_class`, and
|
||||
stands for every class in the cluster that meets it, as
|
||||
`<profile>@<class>`; a ComfyUI profile may carry its own `comfyui`
|
||||
workflow, checkpoint and nodes, and any profile its own `source`. One
|
||||
catalog entry then runs fp8 where the card has it and fp16 on Turing.
|
||||
- **Custom nodes that compile**: `nodes[].build` names directories of a
|
||||
node that are C++/CUDA packages; the gate builds each as a wheel for the
|
||||
card the replica runs on, keeps it on the node, and installs it beside
|
||||
the replica. `comfyui.huggingface_repo` shows a model's weights to a node
|
||||
that loads them by repository name.
|
||||
- **A licence a machine can match**: `license.id`, `commercial`,
|
||||
`excluded_regions`, `revenue_cap_usd`, `attribution`.
|
||||
- **On-demand models in `/v1/models`**, with `loaded` saying whether one is
|
||||
up now; a picture is cut out and put on grey before TripoSR sees it
|
||||
(`LLMGWPrepareForMesh`, rembg when it has no alpha).
|
||||
- **Licences a person leaves out**: on the profile page, by licence, or by
|
||||
rule — every licence forbidding commercial use, every licence granting
|
||||
nothing in a region — so a model under one is neither listed to nor
|
||||
served for that person's keys and sessions (403 `licence_excluded`).
|
||||
- **Presets: a picture or 3D model added by name.** `llmgw ctl model add
|
||||
flux-schnell` or `triposr` adds an entry that comes with llmgw — its
|
||||
workflow (TripoSR's now built in), custom nodes, packages and licence,
|
||||
and a profile by card need rather than class — and has the nodes install
|
||||
ComfyUI when the cluster's settings name none. `llmgw ctl model presets`
|
||||
lists them; the console's **A** on the models screen offers them beside
|
||||
a definition file.
|
||||
|
||||
### Fixed
|
||||
|
||||
- A model waiting for another on-demand model to give up the card failed at
|
||||
once as "cannot be placed"; it now waits, and a job with it.
|
||||
- A model evicted for being idle was placed again on the next pass, ahead of
|
||||
the one it made room for.
|
||||
- A job or batch leased by a standby control plane, whose router has no
|
||||
endpoints, waited on "loading" for good; they are served only by the
|
||||
leader. A job told its model fits nowhere asks again for five minutes
|
||||
before failing, which an agent re-registering makes true for seconds.
|
||||
- An on-demand replica adopted after a restart was never idle enough to
|
||||
evict, so a model waiting for its card waited out its whole idle timeout;
|
||||
it counts as used at adoption.
|
||||
- A picture in a prompt was counted as its base64 by the context check, so
|
||||
one 1280x720 PNG was "138 thousand tokens" and a vision model refused it;
|
||||
a picture or a sound now counts as about a thousand.
|
||||
- An on-demand model of a higher class was evicted, idle, for a lower-class
|
||||
one two minutes into a lull; it keeps the card through its idle timeout,
|
||||
and a model waiting on it is told so.
|
||||
- A model removed from the catalog stayed wanted, so added again it loaded
|
||||
unasked.
|
||||
- A node that loads its weights by repository name (sf3d) went to Hugging
|
||||
Face for a gated repository and got a 401: the agent did not hand the
|
||||
gate `comfyui.huggingface_repo`, so the weights on the node were never
|
||||
linked into its cache.
|
||||
- **ComfyUI on a V100.** torch's CUDA 12.8 and newer builds have no Volta
|
||||
kernels, but its cu129 build was taken to run from compute capability
|
||||
7.0, so on a V100 both ComfyUI builds were installed, about 10 GB each,
|
||||
and failed with "no kernel image". Cards older than Turing now get
|
||||
ComfyUI on PyTorch's CUDA 12.6 torch (build `cu126`); a Turing or newer
|
||||
node keeps the build it has.
|
||||
- **The open NVIDIA driver read by its version.** With the open kernel
|
||||
module, the default since 560, the agent read the driver as "for" and so
|
||||
as unknown, and tried every engine build whatever driver it needs.
|
||||
|
||||
## v0.14.3 — 2026-10-10
|
||||
|
||||
3D models from a picture, as jobs: made by ComfyUI on the cluster's cards,
|
||||
|
||||
@@ -30,7 +30,7 @@ Releases track the roadmap phases; see [CHANGELOG.md](CHANGELOG.md).
|
||||
| v0.1.0 | 0 | Skeleton and sim-engine | released |
|
||||
| v0.2.0 | 1 | Static router (filter/score/pick, streaming proxy) | released |
|
||||
| v0.3.0 | 1.5 | Admission control (priority bands) | released |
|
||||
| v0.4.0 | 2 | Agent: GPU/IB discovery, engine supervision | released |
|
||||
| v0.4.0 | 2 | Agent: GPU/IB discovery, engine supervision | released as part of v0.5.0 |
|
||||
| v0.5.0 | 3 | Control plane: catalog, placement, reconciler, ctl | released |
|
||||
| v0.6.0 | 4 | Multi-node placement and fabric awareness | released |
|
||||
| v0.7.0 | — | Conversations, agent memory, disk management | released |
|
||||
@@ -40,8 +40,8 @@ Releases track the roadmap phases; see [CHANGELOG.md](CHANGELOG.md).
|
||||
| v0.11.0 | — | High availability from setup, the setup and console screens, usage sums and per-tenant alerts | released |
|
||||
| v0.12.0 | — | The cluster's settings in the store, in force when changed; the firewall switch; wipe | released |
|
||||
| v0.13.0 | — | The whole system stopped and started from one command; Qwen3Guard judges, on a GPU and CPUs together | released |
|
||||
| v0.14.0 | — | Knowledge bases: documents from people's own machines, kept apart per tenant, answered from | released (v0.14.1: adapters, the tree over the API, the firewall on every machine; v0.14.2: pictures from ComfyUI; v0.14.3: 3D models as jobs) |
|
||||
| v1.0.0 | 5 | Tenancy, prefix affinity, benchmarking | planned |
|
||||
| v0.14.0 | — | Knowledge bases: documents from people's own machines, kept apart per tenant, answered from | released (v0.14.1: adapters, the tree over the API, the firewall on every machine; v0.14.2: pictures from ComfyUI; v0.14.3: 3D models as jobs; v0.14.4: any ComfyUI workflow as a job, presets, licences; v0.14.5: picture and 3D models that add themselves) |
|
||||
| v1.0.0 | 5 | What phase 5 has left: precise KV routing proven on vLLM, the block cost picker, defragmentation across NVLink domains, prefill/decode disaggregation | planned |
|
||||
|
||||
As of v0.6.0 a cluster runs unattended: agents report their hardware, the
|
||||
control plane places replicas — including ones larger than a single machine —
|
||||
@@ -50,6 +50,35 @@ budgets and rate limits decide who may use any of it.
|
||||
|
||||
Since v0.11.0 (each release's detail is in [CHANGELOG.md](CHANGELOG.md)):
|
||||
|
||||
- **Picture and 3D models that add themselves** (v0.14.5). Where a node's
|
||||
card fits flux-schnell or triposr and the catalog makes nothing of that
|
||||
kind, the leader adds it on demand, so a new cluster's portal has its
|
||||
Images and 3D pages; the cluster page and the console show each preset
|
||||
and add it by hand, and `presets.auto` turns it off. Stable Fast 3D's
|
||||
colours can be brought to the picture's (`albedo_match`), and every mesh
|
||||
carries its whole licence.
|
||||
- **Any ComfyUI workflow, and models by name** (v0.14.4). `POST
|
||||
/v1/workflows/runs` runs a ComfyUI model's workflow as a job, its inputs
|
||||
(text, numbers, choices, images, masks, audio, video, files) declared in
|
||||
the catalog and listed in `/v1/models`. `llmgw ctl model add triposr` or
|
||||
`flux-schnell` adds a tested model with no YAML; a profile may name the
|
||||
card it needs instead of a class, and ComfyUI now installs on V100s. A
|
||||
licence carries what a machine can match, and a person can leave
|
||||
licences out on the profile page so no key of theirs reaches such a
|
||||
model. A 3D job waiting for the one card says what holds it and for
|
||||
about how long.
|
||||
- **3D models as jobs** (v0.14.3). `POST /v1/3d/generations` answers with a
|
||||
job, asked after until its mesh is ready to download. ComfyUI makes it on
|
||||
the cluster's own cards, TripoSR being the tested model. The job says how
|
||||
far along it is, the model's licence is written into the GLB, and
|
||||
`per_mesh` prices it. People make them at `/3d` on the portal; `llmgw ctl
|
||||
3d` shows every owner's jobs. A model profile may also load weights of
|
||||
its own, and an admission band may wait longer than the rest, for bulk
|
||||
work.
|
||||
- **Pictures from ComfyUI** (v0.14.2). `POST /v1/images/generations` is made
|
||||
by ComfyUI, behind a gate that demands the replica's key, as an engine the
|
||||
agents install from its source checked against a digest. `per_image`
|
||||
prices it, and people make pictures at `/images` on the portal.
|
||||
- **Adapters, and the tenancy tree over the API** (v0.14.1). `llmgw ctl
|
||||
kb dataset` and `llmgw ctl train` make a LoRA adapter from a collection
|
||||
on a node's spare GPU memory, kept on the mirror and seen only by its
|
||||
|
||||
@@ -96,6 +96,12 @@ func titleOf(src, path string) string {
|
||||
//go:embed docs/admin-api.openapi.json
|
||||
var AdminOpenAPI []byte
|
||||
|
||||
// ClientOpenAPI is the client API described in OpenAPI 3.1, generated from
|
||||
// internal/clientapi's route table and served at /v1/openapi.json.
|
||||
//
|
||||
//go:embed docs/client-api.openapi.json
|
||||
var ClientOpenAPI []byte
|
||||
|
||||
// EvalSuites are the example quality suites under deploy/eval, which the
|
||||
// control plane runs by name when its eval directory has none of the name.
|
||||
//
|
||||
|
||||
+374
-2
@@ -86,6 +86,9 @@
|
||||
{
|
||||
"name": "plan"
|
||||
},
|
||||
{
|
||||
"name": "presets"
|
||||
},
|
||||
{
|
||||
"name": "projects"
|
||||
},
|
||||
@@ -3651,6 +3654,116 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/presets": {
|
||||
"get": {
|
||||
"operationId": "getPresets",
|
||||
"summary": "The models that come with llmgw: whether each fits this cluster, is in the catalog, was declined",
|
||||
"tags": [
|
||||
"presets"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PresetsView"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/Unauthorized"
|
||||
},
|
||||
"default": {
|
||||
"$ref": "#/components/responses/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/presets/auto": {
|
||||
"put": {
|
||||
"operationId": "putPresetsAuto",
|
||||
"summary": "Turn on or off the adding of presets when a node fits them",
|
||||
"tags": [
|
||||
"presets"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/Actor"
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PresetsAutoRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PresetsView"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/Unauthorized"
|
||||
},
|
||||
"default": {
|
||||
"$ref": "#/components/responses/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/presets/{name}": {
|
||||
"post": {
|
||||
"operationId": "postPresetsName",
|
||||
"summary": "Add a preset to the catalog, and clear its decline",
|
||||
"tags": [
|
||||
"presets"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"description": "The preset's name, as `llmgw ctl model presets` lists it.",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/Actor"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ModelAdded"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/Unauthorized"
|
||||
},
|
||||
"default": {
|
||||
"$ref": "#/components/responses/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/projects": {
|
||||
"post": {
|
||||
"operationId": "postProjects",
|
||||
@@ -5203,7 +5316,7 @@
|
||||
}
|
||||
},
|
||||
"Unauthorized": {
|
||||
"description": "The admin token is missing or wrong.",
|
||||
"description": "The token is missing or wrong.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
@@ -7481,6 +7594,85 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"PresetView": {
|
||||
"type": "object",
|
||||
"description": "PresetView is one preset as it stands in this cluster.",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"makes": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"type": "string"
|
||||
},
|
||||
"card": {
|
||||
"type": "string"
|
||||
},
|
||||
"licence": {
|
||||
"$ref": "#/components/schemas/catalog.License"
|
||||
},
|
||||
"fits": {
|
||||
"type": "boolean",
|
||||
"description": "Fits is whether some node has a card that meets the preset's need; FitsClasses names those classes."
|
||||
},
|
||||
"fits_classes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"in_catalog": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"added_by": {
|
||||
"type": "string",
|
||||
"description": "AddedBy is \"auto\" when the leader added it, who did otherwise, \"\" when it was not added as a preset; AddedAt is when."
|
||||
},
|
||||
"added_at": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"declined": {
|
||||
"type": "boolean",
|
||||
"description": "Declined is whether somebody removed it after it was added, so it is not added again by itself; adding it again clears that."
|
||||
},
|
||||
"blocked": {
|
||||
"type": "string",
|
||||
"description": "Blocked is why the leader does not add it by itself — presets.auto off, no ComfyUI, no card that fits, declined, another model already making the same — empty when it would or has."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PresetsAutoRequest": {
|
||||
"type": "object",
|
||||
"description": "PresetsAutoRequest turns the automatic adding of presets on or off.",
|
||||
"properties": {
|
||||
"on": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PresetsView": {
|
||||
"type": "object",
|
||||
"description": "PresetsView is the models that come with llmgw, and whether the leader adds them by itself.",
|
||||
"properties": {
|
||||
"auto": {
|
||||
"type": "boolean",
|
||||
"description": "Auto is whether a preset is added when a node fits it and the catalog has no model that makes what it makes (presets.auto)."
|
||||
},
|
||||
"comfyui": {
|
||||
"type": "string",
|
||||
"description": "ComfyUI is engines.comfyui as it stands: the version the nodes install, \"\" for none — in which case adding a preset sets it, and the control planes start again on that."
|
||||
},
|
||||
"presets": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/PresetView"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ProjectView": {
|
||||
"type": "object",
|
||||
"description": "ProjectView is a project, with how many people and keys are in it.",
|
||||
@@ -8774,7 +8966,14 @@
|
||||
},
|
||||
"output": {
|
||||
"type": "string",
|
||||
"description": "Output is what the workflow makes: pictures (the default), asked for at /v1/images/generations, or meshes, asked for as a job at /v1/3d/generations from a picture."
|
||||
"description": "Output is what the workflow makes: pictures (the default), asked for at /v1/images/generations; meshes, asked for as a job at /v1/3d/generations from a picture; or video, audio or files. Every kind is asked for as a job at /v1/workflows/runs too."
|
||||
},
|
||||
"inputs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/catalog.Input"
|
||||
},
|
||||
"description": "Inputs are what the workflow takes from a request at /v1/workflows/runs, each the placeholder of its name."
|
||||
},
|
||||
"nodes": {
|
||||
"type": "array",
|
||||
@@ -8782,6 +8981,14 @@
|
||||
"$ref": "#/components/schemas/catalog.CustomNode"
|
||||
},
|
||||
"description": "Nodes are custom nodes the workflow needs, put in each replica's own custom_nodes at the commit named."
|
||||
},
|
||||
"huggingface_repo": {
|
||||
"type": "string",
|
||||
"description": "HuggingFaceRepo is the repository a custom node loads the weights by name from (Stable Fast 3D's loader asks for stabilityai/stable-fast-3d): the replica's weights are shown to the node there, in the Hugging Face cache of the engines' user, so nothing is fetched and no token is needed when it runs."
|
||||
},
|
||||
"environment": {
|
||||
"type": "string",
|
||||
"description": "Environment names the models that may share one ComfyUI replica: every model of an environment agrees on the custom nodes they both name, so one replica can carry all of them and ComfyUI moves between their weights itself. Empty is an environment of the model alone."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -8803,6 +9010,13 @@
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Requirements are the PyPI packages the node needs, by name and version range only. They are installed beside the replica, never into ComfyUI's environment: a package named here at the range named, and every other one at the version ComfyUI already runs. One named here is first on ComfyUI's path, so its range must suit ComfyUI too."
|
||||
},
|
||||
"build": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Build are directories of the repository that are Python packages to be compiled rather than downloaded: C++ and CUDA extensions no index has (Stable Fast 3D's texture_baker and uv_unwrapper). Each is built as a wheel with ComfyUI's Python for the card the replica runs on, kept on the node for the next replica on the same kind of card, and installed beside the replica like its requirements."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -8858,6 +9072,20 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.GPUNeed": {
|
||||
"type": "object",
|
||||
"description": "GPUNeed is what card a profile needs.",
|
||||
"properties": {
|
||||
"min_compute_capability": {
|
||||
"type": "number",
|
||||
"description": "MinComputeCapability is the oldest architecture that runs it: 7.5 is Turing, 8.0 Ampere (bf16, flash-attention 2), 8.9 Ada (fp8), 9.0 Hopper."
|
||||
},
|
||||
"min_memory_gb": {
|
||||
"type": "integer",
|
||||
"description": "MinMemoryGB is the card's own memory it needs."
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.GuardModel": {
|
||||
"type": "object",
|
||||
"description": "GuardModel is how a judge model's answers are read.",
|
||||
@@ -8875,10 +9103,55 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.Input": {
|
||||
"type": "object",
|
||||
"description": "Input is one thing a workflow takes from a request: the placeholder {{name}} in its graph, filled with the request's inputs.name.",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name is the placeholder's, and the request's key."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Type is one of text, int, float, bool, choice, image, mask, audio, video, file. The last five are files, sent as base64, a data URL, or the id of a file uploaded to /v1/files, and put in ComfyUI's input directory; the placeholder gets the name they were given there."
|
||||
},
|
||||
"required": {
|
||||
"type": "boolean",
|
||||
"description": "Required inputs must be in every request; the others take Default, or the workflow's own {{name|default}}."
|
||||
},
|
||||
"default": {},
|
||||
"min": {
|
||||
"type": "number",
|
||||
"description": "Min and Max bound a number; for text, Max bounds its length."
|
||||
},
|
||||
"max": {
|
||||
"type": "number"
|
||||
},
|
||||
"choices": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Choices are what a choice may be."
|
||||
},
|
||||
"max_mb": {
|
||||
"type": "integer",
|
||||
"description": "MaxMB bounds a file input; zero is the type's own bound."
|
||||
},
|
||||
"doc": {
|
||||
"type": "string",
|
||||
"description": "Doc says what the input is for, to whoever fills it in."
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.License": {
|
||||
"type": "object",
|
||||
"description": "License is the terms what a model makes comes under: said beside every result, and written into a mesh, which travels without the API.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "ID names the licence for a machine: an SPDX identifier where there is one (MIT, Apache-2.0, CC-BY-NC-4.0), else a lowercase name of the licence's own (stability-community, tencent-hunyuan-community). What a person's or a site's choice of licences matches on. Name is for people."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Name is the licence's own: MIT, Apache-2.0."
|
||||
@@ -8889,6 +9162,26 @@
|
||||
"notice": {
|
||||
"type": "string",
|
||||
"description": "Notice is what must accompany what was made: attribution, terms on the output, what the weights were trained on."
|
||||
},
|
||||
"commercial": {
|
||||
"type": "boolean",
|
||||
"description": "Commercial says whether what is made may be used commercially: nil is not said, which is not the same as yes."
|
||||
},
|
||||
"excluded_regions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "ExcludedRegions are where the licence grants nothing: ISO 3166 codes, and EU for the union (Hunyuan's: EU, UK, KR)."
|
||||
},
|
||||
"revenue_cap_usd": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "RevenueCapUSD is the yearly revenue above which the licence asks for another agreement (Stability's community licence: 1000000). Zero is none."
|
||||
},
|
||||
"attribution": {
|
||||
"type": "string",
|
||||
"description": "Attribution is what a product using the output must show: \"Powered by Stability AI\"."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -8999,6 +9292,10 @@
|
||||
"origin": {
|
||||
"$ref": "#/components/schemas/catalog.Origin",
|
||||
"description": "Origin is the registry repository the weights came from, at which commit, and each file's checksum there. Written when a model is served from the registry; for one that was not, worked out from the mirror's record of where it fetched the file. It is what lets the control plane say that the repository has published different weights since, and move the model to them."
|
||||
},
|
||||
"shared": {
|
||||
"$ref": "#/components/schemas/catalog.SharedComfy",
|
||||
"description": "Shared is set on an environment's hidden entry only: the members its replica answers for. Made by the catalog, never written."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -9151,6 +9448,32 @@
|
||||
"kv_events": {
|
||||
"type": "boolean",
|
||||
"description": "KVEvents has vLLM publish what its prefix cache holds, and the router route this model's requests by it: to the replica holding the most of a prompt's leading blocks (plan §7.5 tier 2). vLLM only.\n\nOff by default, because it costs something on every request: the router asks a replica to tokenize the prompt before placing it, a round trip and the chat template run twice. It pays where prompts share long prefixes that the approximate tree guesses wrong — many replicas, conversations that move between them, evictions. The engine is started with sha256_cbor block hashing and a fixed PYTHONHASHSEED, which the router's hashing assumes; arguments overriding either leave the index empty, and the agent says so in its log."
|
||||
},
|
||||
"gpu": {
|
||||
"$ref": "#/components/schemas/catalog.GPUNeed",
|
||||
"description": "GPU says what card the profile needs, in place of naming its class: it stands for every class in the cluster that meets it. A catalog entry written once then places sensibly on any site's cards."
|
||||
},
|
||||
"comfyui": {
|
||||
"$ref": "#/components/schemas/catalog.ProfileComfyUI",
|
||||
"description": "ComfyUI is this profile's own workflow, checkpoint and nodes, over the model's: an fp8 workflow where the card has fp8, fp16 where it has not."
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.ProfileComfyUI": {
|
||||
"type": "object",
|
||||
"description": "ProfileComfyUI is what a ComfyUI profile runs differently from the model: each field set replaces the model's.",
|
||||
"properties": {
|
||||
"workflow": {
|
||||
"type": "string"
|
||||
},
|
||||
"checkpoint": {
|
||||
"type": "string"
|
||||
},
|
||||
"nodes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/catalog.CustomNode"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -9226,6 +9549,51 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.SharedComfy": {
|
||||
"type": "object",
|
||||
"description": "SharedComfy is what an environment's entry carries of its members.",
|
||||
"properties": {
|
||||
"environment": {
|
||||
"type": "string"
|
||||
},
|
||||
"members": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/catalog.SharedMember"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"catalog.SharedMember": {
|
||||
"type": "object",
|
||||
"description": "SharedMember is one model a shared replica answers for.",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"aliases": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"description": "Source is the member's weights, which the replica's node fetches."
|
||||
},
|
||||
"hf_repo": {
|
||||
"type": "string",
|
||||
"description": "HFRepo is the repository its node loads the weights by name from."
|
||||
},
|
||||
"workflow": {
|
||||
"type": "string",
|
||||
"description": "Workflow and Checkpoint are what a request for it is sent."
|
||||
},
|
||||
"checkpoint": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"eval.Live": {
|
||||
"type": "object",
|
||||
"description": "Live is a run as it stands: one running, with how many of its cases are done, or one finished.",
|
||||
@@ -10094,6 +10462,10 @@
|
||||
"type": "boolean",
|
||||
"description": "Tools says the model makes tool calls the engine returns as calls: it is written into the catalog, where clients and editors read it. Check a running replica with llmgw ctl tool-check before saying so."
|
||||
},
|
||||
"embeddings": {
|
||||
"type": "boolean",
|
||||
"description": "Embeddings serves it as an embedding model, which its GGUF header says by itself for most: --embedding, many slots, a batch that holds a whole passage, /v1/embeddings."
|
||||
},
|
||||
"cpu_cores": {
|
||||
"type": "integer",
|
||||
"description": "CPUCores is what a replica computes on; zero takes half the smallest node it fits on."
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
+67
-1
@@ -38,6 +38,14 @@ export ANTHROPIC_BASE_URL=https://llm.example.com
|
||||
export ANTHROPIC_API_KEY=$LLMGW_API_KEY
|
||||
```
|
||||
|
||||
### The API described
|
||||
|
||||
Every endpoint is described in OpenAPI 3.1 at `/v1/openapi.json`. It needs
|
||||
no key, so a client generator can be pointed at it. `/docs/api` shows it in
|
||||
Swagger UI, where *Authorize* takes a key and *Try it out* sends a request to
|
||||
the gateway. People with a part in running the gateway also find the admin
|
||||
API's document there.
|
||||
|
||||
## A first request
|
||||
|
||||
### curl
|
||||
@@ -526,6 +534,64 @@ curl https://llm.example.com/mcp \
|
||||
-d '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}'
|
||||
```
|
||||
|
||||
**Pictures, 3D models, vision and workflows.** Where the gateway has the
|
||||
models for them, the same server offers more tools — only those it has a
|
||||
model for:
|
||||
|
||||
| Tool | Does |
|
||||
|---|---|
|
||||
| `generate_image` | A picture from a prompt. `style` adds what a picture for a mesh wants: `concept` (one object, three-quarter view, grey background), `side` (an exact side view), `texture` (a seamless tile) or `none`. Answers the PNG's `file_id`, `url` and `seed`, with a 512 px preview to look at. |
|
||||
| `generate_mesh` | A GLB from a picture — `image` is a `file-…` id (a `generate_image` result, say), a data URL or base64 — or from a `prompt`, for which a concept picture is made first. `seed`, `resolution`, `texture_resolution`, and any other input the model's workflow declares in `inputs`. Answers the GLB's `file_id`, `url` and licence. |
|
||||
| `review_images` | Asks a vision model about one to four pictures (each shrunk to 1280 px on its long side); `json_schema` makes it answer that JSON. |
|
||||
| `run_workflow` | Runs a ComfyUI workflow from the inputs its catalog entry declares, and answers its result file. |
|
||||
| `job_status` | Where a mesh or a workflow run stands, and its file when done; `wait_seconds` waits for it. |
|
||||
| `gateway_status` | The picture, 3D, vision and workflow models, whether each is loaded on a GPU now, a workflow's inputs, and your last jobs. |
|
||||
|
||||
Each tool makes its request of the gateway under your key, so your
|
||||
allowlist, limits, left-out licences and budget apply, and it is charged
|
||||
and listed like any other request. What it makes is kept as your file for
|
||||
as long as job results are: fetch it from `url` with the same key (`curl -H
|
||||
"Authorization: Bearer $LLMGW_API_KEY" -o rock.glb <url>`). A tool server
|
||||
over HTTP cannot write to your disk, so an agent that needs the file
|
||||
locally — to import it in Blender — fetches it, or goes through a small
|
||||
local bridge that does.
|
||||
|
||||
A picture can be uploaded once and named by its id after: `POST /v1/files`
|
||||
with `purpose=vision` (or `user_data`) keeps it, for as long as job results
|
||||
are kept, as a file of yours that `generate_mesh`, `review_images` and a
|
||||
workflow's file inputs take as `file-…`. A call is at most 64 MB.
|
||||
|
||||
A model that is not loaded is waited for: a picture or a look at one whose
|
||||
model is starting, or waiting for another to give up the GPU, waits as a
|
||||
mesh does, saying so, rather than failing with "model loading".
|
||||
|
||||
A mesh takes from half a minute to a few minutes. A client that takes the
|
||||
answer as a stream (`Accept: text/event-stream`, as Claude Code does) is
|
||||
answered that way: `notifications/progress` for the call's
|
||||
`progressToken` while it runs — queued, waiting for the GPU, the node and
|
||||
its percent — then the result, and the call waits up to ten minutes. One
|
||||
answered in one piece waits 50 seconds; a job not done by then is answered
|
||||
with its `job_id`, to ask after with `job_status`. `wait_seconds` (up to
|
||||
900) sets either.
|
||||
|
||||
```
|
||||
claude mcp add --transport http llmgw https://llm.example.com/mcp \
|
||||
--header "Authorization: Bearer $LLMGW_API_KEY"
|
||||
```
|
||||
|
||||
### Licences you leave out
|
||||
|
||||
A model's licence is in `/v1/models` (`license`: its `id`, `name`, whether
|
||||
it allows commercial use and the regions it grants nothing in). On your
|
||||
profile page, under **Licences**, you can leave licences out: one by one,
|
||||
every licence that forbids commercial use, or every licence that grants
|
||||
nothing in a region you name (`EU` for the union). The rules cover models
|
||||
added later too. From then on those models are not listed to your keys and
|
||||
a request for one is refused with 403 and the code `licence_excluded`,
|
||||
naming the choice that left it out — on every key you own and on the
|
||||
portal's pages, whatever a key's own allowlist says. A change reaches keys
|
||||
already in use within a minute.
|
||||
|
||||
### Headers llmgw sends back
|
||||
|
||||
| Header | Says |
|
||||
@@ -545,7 +611,7 @@ its usual exception with the gateway's message in it. The ones worth knowing:
|
||||
|---|---|
|
||||
| 400 | Besides a malformed request: a prompt too long for the model, or a guardrail policy refused it (the code `content_policy_violation`). |
|
||||
| 401 | No key, a mistyped one, or one that was revoked or has expired. |
|
||||
| 403 | The key may not use that model. |
|
||||
| 403 | The key may not use that model; with the code `licence_excluded`, its licence is one you left out on your profile page. |
|
||||
| 429 | A rate limit or budget of the key, its project or its team was reached. `Retry-After` says when to try again, and is absent when waiting will not help — a spent monthly budget. |
|
||||
| 503 | No model of that name is served (the message lists the ones that are), the model is still loading, or every replica is busy and the queue is full. The SDKs retry by themselves; a name that is not served will not start to be. |
|
||||
| 504 | Every replica was busy for as long as the key's band may wait. `Retry-After` says when to send it again. |
|
||||
|
||||
+80
-9
@@ -1300,6 +1300,37 @@ waits, and sends the pictures back as `b64_json`.
|
||||
**On the cluster's own cards.** Use engine `comfyui`. The model is placed on a
|
||||
GPU node like any other, started when asked for, and stopped when unused.
|
||||
|
||||
**The short way: a preset.** Some models come with llmgw, with their
|
||||
workflow, custom nodes, packages and licence already found and tried:
|
||||
|
||||
```
|
||||
llmgw ctl model presets
|
||||
llmgw ctl model add flux-schnell # pictures, Apache 2.0, a card of 24 GB, Volta or newer
|
||||
llmgw ctl model add triposr # 3D models from a picture, MIT, a card of 8 GB
|
||||
```
|
||||
|
||||
A preset's profile says the card it needs, not a class, so it places on
|
||||
whatever cards the site has. When the cluster's settings name no ComfyUI,
|
||||
adding one sets `engines.comfyui` to the version this release installs, and
|
||||
every node with an NVIDIA GPU installs it; a cluster that names a version,
|
||||
or `""` for none, keeps it; the control planes then start again on that
|
||||
setting, standbys first.
|
||||
|
||||
They also come by themselves. Once a node has a card that fits one, and the
|
||||
catalog has nothing that makes what it makes, the leader adds it, on demand —
|
||||
where the cluster already installs ComfyUI; it never sets `engines.comfyui`
|
||||
by itself. A preset somebody removes stays out until it is added again.
|
||||
`llmgw ctl model presets auto off` (the setting `presets.auto`) stops it.
|
||||
|
||||
The cluster page on the portal has a **Pictures and 3D models** card under
|
||||
the models: each preset, the classes of card here it fits, whether it is in
|
||||
the catalog and who added it, why the leader has not, an **Add** button (one
|
||||
that would also install ComfyUI says so first) and the switch for adding
|
||||
them by themselves. In the console, the models screen shows the same: **A**
|
||||
adds one, **P** turns adding them by themselves on or off.
|
||||
`llmgw ctl model presets` prints it. The rest of this section is for a model
|
||||
of your own.
|
||||
|
||||
The node must offer the engine. Ask for it in the cluster's settings, and every
|
||||
node with an NVIDIA GPU installs it:
|
||||
|
||||
@@ -1312,8 +1343,10 @@ digest llmgw holds for that version. GitHub publishes none for a tag's archive,
|
||||
so a version llmgw does not know is refused. The agent then builds a Python
|
||||
environment beside the source, under `/opt/llmgw/engines/comfyui/`. Its
|
||||
dependencies are resolved as PyPI stood the day after the release. torch comes
|
||||
from PyPI (CUDA 13), or from PyTorch's CUDA 12.9 build where the driver is older
|
||||
than 580. The install is checked on the node's GPU, and takes about 10 GB.
|
||||
from PyPI (CUDA 13), from PyTorch's CUDA 12.9 build where the driver is older
|
||||
than 580, or from its CUDA 12.6 build on cards older than Turing (a V100):
|
||||
torch's CUDA 12.8 and newer builds have no kernels for them. The install is
|
||||
checked on the node's GPU, and takes about 10 GB.
|
||||
`engine_overrides` can keep it off nodes that should not have it.
|
||||
|
||||
Alternatively, install ComfyUI by hand. You need a directory with `main.py` and
|
||||
@@ -1794,6 +1827,23 @@ same event about the same thing is sent at most once an hour, so a budget that
|
||||
refuses a thousand requests is one message. `llmgw ctl notify test` sends a
|
||||
test event to each webhook and says how each answered.
|
||||
|
||||
Setup asks for them: **Notification webhooks** on its first page, or
|
||||
`--webhook` to `llmgw server init`, as often as there are webhooks:
|
||||
|
||||
```
|
||||
sudo llmgw server init --admin ops@example.com \
|
||||
--webhook https://hooks.slack.com/services/… \
|
||||
--webhook json:https://ops.example.com/llmgw
|
||||
```
|
||||
|
||||
An address of Slack's, or one with `/hooks/` in it (Mattermost, Rocket.Chat)
|
||||
or ending in `/slack`, is sent Slack's `{"text": …}`; any other the event as
|
||||
JSON; `slack:` or `json:` in front says which. They are added to the
|
||||
cluster's settings beside any already there — run again, nothing is added
|
||||
twice — and once the control plane runs on them, each is sent a test, whose
|
||||
answer setup prints. Events to choose and a signing secret are set in the
|
||||
settings afterwards (`llmgw ctl config edit`).
|
||||
|
||||
### Tracing
|
||||
|
||||
Metrics say that a model took four minutes to start; a trace says where they
|
||||
@@ -2072,7 +2122,13 @@ curl -X POST http://gateway:8080/v1/3d/generations/job_…/cancel -H "Authorizat
|
||||
- **Status:** `queued`, `running`, `completed`, `failed` (with `error`),
|
||||
`cancelling`, `cancelled`, `expired` (not finished within 24 h).
|
||||
`progress` carries what the engine said of the work so far, once it says
|
||||
anything; `GET /v1/3d/generations` lists the caller's jobs.
|
||||
anything; `GET /v1/3d/generations` lists the caller's jobs. While the
|
||||
model waits for another on-demand model to give up the card,
|
||||
`progress` is `{"state":"waiting_gpu","held_by":"flux-schnell","eta_seconds":N}`:
|
||||
N is when the holder is stopped (idle and old enough to evict, or at its
|
||||
idle timeout) plus how long the model's last start took, and is left out
|
||||
when that is not known. A request made directly gets the same as a 503
|
||||
with `X-Llmgw-Waiting-For`, `X-Llmgw-Eta-Seconds` and `Retry-After`.
|
||||
- **Refused at the door:** no key, a model that is not there or not in the
|
||||
key's allowlist, a request the model cannot serve. Refused when served,
|
||||
and said as the job's error: a spent budget, the guardrails, a model
|
||||
@@ -2080,7 +2136,10 @@ curl -X POST http://gateway:8080/v1/3d/generations/job_…/cancel -H "Authorizat
|
||||
- **How it is served:** the request is kept as it was sent and replayed by
|
||||
whichever gateway holds the job's lease, through the same path a
|
||||
client's request takes — limits, admission in the key's band, guardrails,
|
||||
accounting. It is one usage record under the job's id, tagged
|
||||
accounting — by the leading control plane, since a standby has nothing
|
||||
to send it to. A model said to fit nowhere is asked for again for five
|
||||
minutes before that is the job's error: an agent re-registering says so
|
||||
for a few seconds. It is one usage record under the job's id, tagged
|
||||
`job=<id>`, charged like any request; `GET` shows the usage once it is
|
||||
done. A model still loading, a rate limit or a full queue is waited out
|
||||
for as long as the job has: nobody is holding a connection, which is the
|
||||
@@ -2105,38 +2164,50 @@ Its workflow is a JSON file in ComfyUI's API format: `{{image}}` is the
|
||||
uploaded picture, which a `LoadImage` node reads; `{{seed}}`,
|
||||
`{{resolution|256}}` and `{{checkpoint}}` are as for pictures. The node that
|
||||
saves the mesh may save a GLB or an OBJ; an OBJ leaves the gateway as a GLB,
|
||||
vertex colours kept. TripoSR (MIT) on any card of 8 GB:
|
||||
vertex colours kept.
|
||||
|
||||
TripoSR (MIT), on any card of 8 GB, comes with llmgw: `llmgw ctl model add
|
||||
triposr`. What that adds is this entry, and its workflow is built in:
|
||||
|
||||
```yaml
|
||||
- name: triposr
|
||||
source: hf:stabilityai/TripoSR/model.ckpt
|
||||
comfyui:
|
||||
workflow: /etc/llmgw/workflows/triposr.json # on every control plane
|
||||
workflow: triposr # built in; a model of your own names a JSON file on every control plane
|
||||
output: meshes
|
||||
nodes:
|
||||
- repo: https://github.com/flowtyone/ComfyUI-Flowty-TripoSR
|
||||
commit: a0c94ac60a7cc062604f61aeeea6d0d493521de3
|
||||
requirements: [omegaconf, trimesh, scikit-image, imageio,
|
||||
"transformers>=4.50.3,<5", "huggingface-hub<1", tokenizers]
|
||||
"transformers>=4.50.3,<5", "huggingface-hub<1", tokenizers,
|
||||
rembg, onnxruntime]
|
||||
license:
|
||||
id: MIT
|
||||
name: MIT
|
||||
commercial: true
|
||||
url: https://huggingface.co/stabilityai/TripoSR/blob/main/LICENSE
|
||||
notice: "Made with TripoSR (Stability AI and Tripo AI, MIT). ..."
|
||||
scaling: {min: 0, max: 1, idle_timeout: 10m}
|
||||
profiles:
|
||||
- {name: gpu, engine: comfyui, gpu_class: 6000-24g, tp: 1}
|
||||
- {name: gpu, engine: comfyui, tp: 1, gpu: {min_compute_capability: 7.0, min_memory_gb: 8}}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"1": {"class_type": "LoadImage", "inputs": {"image": "{{image}}"}},
|
||||
"5": {"class_type": "LLMGWPrepareForMesh", "inputs": {"image": ["1", 0], "mask": ["1", 1],
|
||||
"foreground_ratio": 0.85, "background": 0.5, "remove_background": "auto", "rembg_model": "u2net"}},
|
||||
"2": {"class_type": "TripoSRModelLoader", "inputs": {"model": "{{checkpoint}}", "chunk_size": 8192}},
|
||||
"3": {"class_type": "TripoSRSampler", "inputs": {"model": ["2", 0], "reference_image": ["1", 0],
|
||||
"3": {"class_type": "TripoSRSampler", "inputs": {"model": ["2", 0], "reference_image": ["5", 0],
|
||||
"geometry_resolution": "{{resolution|256}}", "threshold": 25.0}},
|
||||
"4": {"class_type": "TripoSRViewer", "inputs": {"mesh": ["3", 0]}}
|
||||
}
|
||||
```
|
||||
|
||||
`LLMGWPrepareForMesh` comes with the gate: it cuts the object out — by the
|
||||
picture's alpha, or by rembg where it has none — and centres it on a plain
|
||||
background, without which the background becomes geometry.
|
||||
|
||||
- **Custom nodes** are named by https repository and full commit (a branch
|
||||
is refused: it moves). The gate puts each in the replica's own
|
||||
`custom_nodes` and installs its `requirements` beside the replica, never
|
||||
|
||||
+262
-2
@@ -65,7 +65,10 @@ rather than repeated.
|
||||
| `workflow` | `string` | [ComfyUI](#comfyui) |
|
||||
| `checkpoint` | `string` | [ComfyUI](#comfyui) |
|
||||
| `output` | `string` | [ComfyUI](#comfyui) |
|
||||
| `inputs` | `[]Input` | [ComfyUI](#comfyui) |
|
||||
| `nodes` | `[]CustomNode` | [ComfyUI](#comfyui) |
|
||||
| `huggingface_repo` | `string` | [ComfyUI](#comfyui) |
|
||||
| `environment` | `string` | [ComfyUI](#comfyui) |
|
||||
| `dir` | `string` | [ComfyUIConfig](#comfyuiconfig) |
|
||||
| `python` | `string` | [ComfyUIConfig](#comfyuiconfig) |
|
||||
| `interval` | `time.Duration` | [Control](#control) |
|
||||
@@ -82,6 +85,7 @@ rather than repeated.
|
||||
| `repo` | `string` | [CustomNode](#customnode) |
|
||||
| `commit` | `string` | [CustomNode](#customnode) |
|
||||
| `requirements` | `[]string` | [CustomNode](#customnode) |
|
||||
| `build` | `[]string` | [CustomNode](#customnode) |
|
||||
| `id` | `string` | [Endpoint](#endpoint) |
|
||||
| `url` | `string` | [Endpoint](#endpoint) |
|
||||
| `api_key` | `string` | [Endpoint](#endpoint) |
|
||||
@@ -117,8 +121,19 @@ rather than repeated.
|
||||
| `name` | `string` | [Federation](#federation) |
|
||||
| `interval` | `time.Duration` | [Federation](#federation) |
|
||||
| `enabled` | `bool` | [FirewallSettings](#firewallsettings) |
|
||||
| `min_compute_capability` | `float64` | [GPUNeed](#gpuneed) |
|
||||
| `min_memory_gb` | `int` | [GPUNeed](#gpuneed) |
|
||||
| `format` | `string` | [GuardModel](#guardmodel) |
|
||||
| `categories` | `[]string` | [GuardModel](#guardmodel) |
|
||||
| `name` | `string` | [Input](#input) |
|
||||
| `type` | `string` | [Input](#input) |
|
||||
| `required` | `bool` | [Input](#input) |
|
||||
| `default` | `any` | [Input](#input) |
|
||||
| `min` | `*float64` | [Input](#input) |
|
||||
| `max` | `*float64` | [Input](#input) |
|
||||
| `choices` | `[]string` | [Input](#input) |
|
||||
| `max_mb` | `int` | [Input](#input) |
|
||||
| `doc` | `string` | [Input](#input) |
|
||||
| `model` | `string` | [JudgePolicy](#judgepolicy) |
|
||||
| `models` | `[]string` | [JudgePolicy](#judgepolicy) |
|
||||
| `input` | `string` | [JudgePolicy](#judgepolicy) |
|
||||
@@ -133,9 +148,14 @@ rather than repeated.
|
||||
| `notice` | `string` | [Landing](#landing) |
|
||||
| `language` | `string` | [Landing](#landing) |
|
||||
| `docs_sign_in` | `bool` | [Landing](#landing) |
|
||||
| `id` | `string` | [License](#license) |
|
||||
| `name` | `string` | [License](#license) |
|
||||
| `url` | `string` | [License](#license) |
|
||||
| `notice` | `string` | [License](#license) |
|
||||
| `commercial` | `*bool` | [License](#license) |
|
||||
| `excluded_regions` | `[]string` | [License](#license) |
|
||||
| `revenue_cap_usd` | `int64` | [License](#license) |
|
||||
| `attribution` | `string` | [License](#license) |
|
||||
| `bin` | `string` | [LlamaCppConfig](#llamacppconfig) |
|
||||
| `parallel` | `int` | [LlamaCppConfig](#llamacppconfig) |
|
||||
| `threads` | `int` | [LlamaCppConfig](#llamacppconfig) |
|
||||
@@ -185,6 +205,8 @@ rather than repeated.
|
||||
| `no_passwords` | `bool` | [OIDC](#oidc) |
|
||||
| `mirror` | `string` | [Offline](#offline) |
|
||||
| `checksums` | `string` | [Offline](#offline) |
|
||||
| `evict_after_idle` | `time.Duration` | [OnDemandSettings](#ondemandsettings) |
|
||||
| `min_lifetime` | `time.Duration` | [OnDemandSettings](#ondemandsettings) |
|
||||
| `nvidia_smi` | `string` | [Options](#options) |
|
||||
| `ib_root` | `string` | [Options](#options) |
|
||||
| `prefer_nvml` | `bool` | [Options](#options) |
|
||||
@@ -224,6 +246,7 @@ rather than repeated.
|
||||
| `match_ratio` | `float64` | [Prefix](#prefix) |
|
||||
| `balance_abs` | `float64` | [Prefix](#prefix) |
|
||||
| `balance_rel` | `float64` | [Prefix](#prefix) |
|
||||
| `auto` | `bool` | [PresetSettings](#presetsettings) |
|
||||
| `source` | `string` | [PreviousOrigin](#previousorigin) |
|
||||
| `revision` | `string` | [PreviousOrigin](#previousorigin) |
|
||||
| `files` | `[]OriginFile` | [PreviousOrigin](#previousorigin) |
|
||||
@@ -248,6 +271,11 @@ rather than repeated.
|
||||
| `priority` | `int` | [Profile](#profile) |
|
||||
| `startup_timeout` | `time.Duration` | [Profile](#profile) |
|
||||
| `kv_events` | `bool` | [Profile](#profile) |
|
||||
| `gpu` | `*GPUNeed` | [Profile](#profile) |
|
||||
| `comfyui` | `*ProfileComfyUI` | [Profile](#profile) |
|
||||
| `workflow` | `string` | [ProfileComfyUI](#profilecomfyui) |
|
||||
| `checkpoint` | `string` | [ProfileComfyUI](#profilecomfyui) |
|
||||
| `nodes` | `[]CustomNode` | [ProfileComfyUI](#profilecomfyui) |
|
||||
| `activation_wait` | `time.Duration` | [Router](#router) |
|
||||
| `scrape_interval` | `time.Duration` | [Router](#router) |
|
||||
| `scrape_timeout` | `time.Duration` | [Router](#router) |
|
||||
@@ -319,6 +347,8 @@ rather than repeated.
|
||||
| `mail` | `mail.Config` | [Server](#server) |
|
||||
| `serving` | `ServingSettings` | [Server](#server) |
|
||||
| `firewall` | `FirewallSettings` | [Server](#server) |
|
||||
| `presets` | `PresetSettings` | [Server](#server) |
|
||||
| `on_demand` | `OnDemandSettings` | [Server](#server) |
|
||||
| `agents` | `AgentSettings` | [Server](#server) |
|
||||
| `firewall_networks` | `[]string` | [Server](#server) |
|
||||
| `backup_recipients` | `[]string` | [Server](#server) |
|
||||
@@ -783,8 +813,16 @@ must.
|
||||
`string`
|
||||
|
||||
Output is what the workflow makes: pictures (the default), asked for
|
||||
at /v1/images/generations, or meshes, asked for as a job at
|
||||
/v1/3d/generations from a picture.
|
||||
at /v1/images/generations; meshes, asked for as a job at
|
||||
/v1/3d/generations from a picture; or video, audio or files. Every
|
||||
kind is asked for as a job at /v1/workflows/runs too.
|
||||
|
||||
### `inputs`
|
||||
|
||||
`[]Input`
|
||||
|
||||
Inputs are what the workflow takes from a request at
|
||||
/v1/workflows/runs, each the placeholder of its name.
|
||||
|
||||
### `nodes`
|
||||
|
||||
@@ -793,6 +831,25 @@ at /v1/images/generations, or meshes, asked for as a job at
|
||||
Nodes are custom nodes the workflow needs, put in each replica's own
|
||||
custom_nodes at the commit named.
|
||||
|
||||
### `huggingface_repo`
|
||||
|
||||
`string`
|
||||
|
||||
HuggingFaceRepo is the repository a custom node loads the weights by
|
||||
name from (Stable Fast 3D's loader asks for stabilityai/stable-fast-3d):
|
||||
the replica's weights are shown to the node there, in the Hugging Face
|
||||
cache of the engines' user, so nothing is fetched and no token is
|
||||
needed when it runs.
|
||||
|
||||
### `environment`
|
||||
|
||||
`string`
|
||||
|
||||
Environment names the models that may share one ComfyUI replica: every
|
||||
model of an environment agrees on the custom nodes they both name, so
|
||||
one replica can carry all of them and ComfyUI moves between their
|
||||
weights itself. Empty is an environment of the model alone.
|
||||
|
||||
## ComfyUIConfig
|
||||
|
||||
### `dir`
|
||||
@@ -918,6 +975,17 @@ ComfyUI's environment: a package named here at the range named, and
|
||||
every other one at the version ComfyUI already runs. One named here
|
||||
is first on ComfyUI's path, so its range must suit ComfyUI too.
|
||||
|
||||
### `build`
|
||||
|
||||
`[]string`
|
||||
|
||||
Build are directories of the repository that are Python packages to
|
||||
be compiled rather than downloaded: C++ and CUDA extensions no index
|
||||
has (Stable Fast 3D's texture_baker and uv_unwrapper). Each is built
|
||||
as a wheel with ComfyUI's Python for the card the replica runs on,
|
||||
kept on the node for the next replica on the same kind of card, and
|
||||
installed beside the replica like its requirements.
|
||||
|
||||
## Endpoint
|
||||
|
||||
### `id`
|
||||
@@ -1167,6 +1235,21 @@ site whose own firewall does that job; the rules are kept, and true
|
||||
puts them back. Changed in the cluster's settings, it is in force on
|
||||
every node and control plane within seconds.
|
||||
|
||||
## GPUNeed
|
||||
|
||||
### `min_compute_capability`
|
||||
|
||||
`float64`
|
||||
|
||||
MinComputeCapability is the oldest architecture that runs it: 7.5 is
|
||||
Turing, 8.0 Ampere (bf16, flash-attention 2), 8.9 Ada (fp8), 9.0 Hopper.
|
||||
|
||||
### `min_memory_gb`
|
||||
|
||||
`int`
|
||||
|
||||
MinMemoryGB is the card's own memory it needs.
|
||||
|
||||
## GuardModel
|
||||
|
||||
### `format`
|
||||
@@ -1186,6 +1269,62 @@ ShieldGemma: Yes or No), or json ({"safe": false, "categories":
|
||||
Categories the model is asked about, for shieldgemma — each a policy
|
||||
sentence — and the names reported for llamaguard3's S1, S2, ….
|
||||
|
||||
## Input
|
||||
|
||||
### `name`
|
||||
|
||||
`string`
|
||||
|
||||
Name is the placeholder's, and the request's key.
|
||||
|
||||
### `type`
|
||||
|
||||
`string`
|
||||
|
||||
Type is one of text, int, float, bool, choice, image, mask, audio,
|
||||
video, file. The last five are files, sent as base64, a data URL, or
|
||||
the id of a file uploaded to /v1/files, and put in ComfyUI's input
|
||||
directory; the placeholder gets the name they were given there.
|
||||
|
||||
### `required`
|
||||
|
||||
`bool`
|
||||
|
||||
Required inputs must be in every request; the others take Default,
|
||||
or the workflow's own {{name|default}}.
|
||||
|
||||
### `default`
|
||||
|
||||
`any`
|
||||
|
||||
### `min`
|
||||
|
||||
`*float64`
|
||||
|
||||
Min and Max bound a number; for text, Max bounds its length.
|
||||
|
||||
### `max`
|
||||
|
||||
`*float64`
|
||||
|
||||
### `choices`
|
||||
|
||||
`[]string`
|
||||
|
||||
Choices are what a choice may be.
|
||||
|
||||
### `max_mb`
|
||||
|
||||
`int`
|
||||
|
||||
MaxMB bounds a file input; zero is the type's own bound.
|
||||
|
||||
### `doc`
|
||||
|
||||
`string`
|
||||
|
||||
Doc says what the input is for, to whoever fills it in.
|
||||
|
||||
## JudgePolicy
|
||||
|
||||
### `model`
|
||||
@@ -1299,6 +1438,15 @@ to sign in, and without accounts the portal needs an API key.
|
||||
|
||||
## License
|
||||
|
||||
### `id`
|
||||
|
||||
`string`
|
||||
|
||||
ID names the licence for a machine: an SPDX identifier where there is
|
||||
one (MIT, Apache-2.0, CC-BY-NC-4.0), else a lowercase name of the
|
||||
licence's own (stability-community, tencent-hunyuan-community). What a
|
||||
person's or a site's choice of licences matches on. Name is for people.
|
||||
|
||||
### `name`
|
||||
|
||||
`string`
|
||||
@@ -1316,6 +1464,35 @@ Name is the licence's own: MIT, Apache-2.0.
|
||||
Notice is what must accompany what was made: attribution, terms on
|
||||
the output, what the weights were trained on.
|
||||
|
||||
### `commercial`
|
||||
|
||||
`*bool`
|
||||
|
||||
Commercial says whether what is made may be used commercially: nil
|
||||
is not said, which is not the same as yes.
|
||||
|
||||
### `excluded_regions`
|
||||
|
||||
`[]string`
|
||||
|
||||
ExcludedRegions are where the licence grants nothing: ISO 3166 codes,
|
||||
and EU for the union (Hunyuan's: EU, UK, KR).
|
||||
|
||||
### `revenue_cap_usd`
|
||||
|
||||
`int64`
|
||||
|
||||
RevenueCapUSD is the yearly revenue above which the licence asks for
|
||||
another agreement (Stability's community licence: 1000000). Zero is
|
||||
none.
|
||||
|
||||
### `attribution`
|
||||
|
||||
`string`
|
||||
|
||||
Attribution is what a product using the output must show: "Powered by
|
||||
Stability AI".
|
||||
|
||||
## LlamaCppConfig
|
||||
|
||||
### `bin`
|
||||
@@ -1738,6 +1915,25 @@ kept by llmgw bundle import and llmgw bundle trust; every engine file
|
||||
a node fetches from the mirror is checked against it. Read again
|
||||
whenever it changes. Empty is /etc/llmgw/offline.sha256.
|
||||
|
||||
## OnDemandSettings
|
||||
|
||||
### `evict_after_idle`
|
||||
|
||||
`time.Duration`
|
||||
|
||||
EvictAfterIdle is how long an on-demand replica must go unasked-for
|
||||
before a model that wants its card may have it. Zero keeps 2m.
|
||||
|
||||
### `min_lifetime`
|
||||
|
||||
`time.Duration`
|
||||
|
||||
MinLifetime is how long a replica that has just come up is safe from
|
||||
that, so two models do not take turns paying for loads. Zero keeps
|
||||
5m. On one card shared by a picture model and a 3D model, 1m each
|
||||
brings the wait between a picture and its mesh to about a minute.
|
||||
Both are in force on the leader within seconds.
|
||||
|
||||
## Options
|
||||
|
||||
### `nvidia_smi`
|
||||
@@ -1986,6 +2182,20 @@ before affinity is abandoned.
|
||||
|
||||
`float64`
|
||||
|
||||
## PresetSettings
|
||||
|
||||
### `auto`
|
||||
|
||||
`bool`
|
||||
|
||||
Auto has the leading control plane add a picture model (flux-schnell)
|
||||
and a 3D model (triposr) by itself, on demand, once a node has a card
|
||||
that fits one and the catalog has no model that makes the same kind of
|
||||
thing — so a new cluster's portal has its pictures and 3D pages
|
||||
without anybody writing a definition. Only where the cluster already
|
||||
installs ComfyUI (engines.comfyui). A preset somebody removed is not
|
||||
added again by itself. In force on the leader within a minute.
|
||||
|
||||
## PreviousOrigin
|
||||
|
||||
### `source`
|
||||
@@ -2179,6 +2389,39 @@ is started with sha256_cbor block hashing and a fixed PYTHONHASHSEED,
|
||||
which the router's hashing assumes; arguments overriding either leave
|
||||
the index empty, and the agent says so in its log.
|
||||
|
||||
### `gpu`
|
||||
|
||||
`*GPUNeed`
|
||||
|
||||
GPU says what card the profile needs, in place of naming its class:
|
||||
it stands for every class in the cluster that meets it. A catalog
|
||||
entry written once then places sensibly on any site's cards.
|
||||
|
||||
Takes a [GPUNeed](#gpuneed) block.
|
||||
|
||||
### `comfyui`
|
||||
|
||||
`*ProfileComfyUI`
|
||||
|
||||
ComfyUI is this profile's own workflow, checkpoint and nodes, over the
|
||||
model's: an fp8 workflow where the card has fp8, fp16 where it has not.
|
||||
|
||||
Takes a [ProfileComfyUI](#profilecomfyui) block.
|
||||
|
||||
## ProfileComfyUI
|
||||
|
||||
### `workflow`
|
||||
|
||||
`string`
|
||||
|
||||
### `checkpoint`
|
||||
|
||||
`string`
|
||||
|
||||
### `nodes`
|
||||
|
||||
`[]CustomNode`
|
||||
|
||||
## Router
|
||||
|
||||
### `activation_wait`
|
||||
@@ -2755,6 +2998,23 @@ Firewall turns llmgw's firewall on every machine on or off.
|
||||
|
||||
Takes a [FirewallSettings](#firewallsettings) block.
|
||||
|
||||
### `presets`
|
||||
|
||||
`PresetSettings`
|
||||
|
||||
Presets is how the models that come with llmgw reach the catalog.
|
||||
|
||||
Takes a [PresetSettings](#presetsettings) block.
|
||||
|
||||
### `on_demand`
|
||||
|
||||
`OnDemandSettings`
|
||||
|
||||
OnDemand is how models that load when asked for take turns on the
|
||||
cards.
|
||||
|
||||
Takes a [OnDemandSettings](#ondemandsettings) block.
|
||||
|
||||
### `agents`
|
||||
|
||||
`AgentSettings`
|
||||
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"crypto/sha256"
|
||||
"crypto/tls"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
@@ -1131,6 +1132,31 @@ func (a *Agent) startShard(ctx context.Context, m *llmgwv1.StartShard, out chan<
|
||||
stop()
|
||||
spec.Profile.ModelPath = path
|
||||
}
|
||||
// A shared ComfyUI replica's members' weights, each fetched like the
|
||||
// model's, and handed to the gate where they landed.
|
||||
if raw := spec.Profile.Env[engines.SharedModelsEnv]; raw != "" {
|
||||
var ms []map[string]string
|
||||
if err := json.Unmarshal([]byte(raw), &ms); err != nil {
|
||||
report(supervisor.Failed, "the shared replica's models are not readable: "+err.Error(), nil)
|
||||
return
|
||||
}
|
||||
for i, m := range ms {
|
||||
stop := a.watchFetch(m["source"], func(p weights.Progress) {
|
||||
send(&llmgwv1.ShardStatus{State: agentsvc.StateToWire(supervisor.Starting),
|
||||
Fetch: &llmgwv1.FetchProgress{Source: p.Source, BytesDone: p.BytesDone, BytesTotal: p.BytesTotal}})
|
||||
})
|
||||
path, err := a.weights().Ensure(ctx, m["source"])
|
||||
stop()
|
||||
if err != nil {
|
||||
report(supervisor.Failed, fmt.Sprintf("model %s: %v", m["name"], err), nil)
|
||||
return
|
||||
}
|
||||
ms[i]["path"] = path
|
||||
}
|
||||
b, _ := json.Marshal(ms)
|
||||
spec.Profile.Env = maps.Clone(spec.Profile.Env)
|
||||
spec.Profile.Env[engines.SharedModelsEnv] = string(b)
|
||||
}
|
||||
// Adapters are fetched like the model, and before the engine starts: it
|
||||
// loads them at start, and one missing is a replica that answers for the
|
||||
// base model under the adapter's name.
|
||||
|
||||
@@ -3,6 +3,7 @@ package discovery
|
||||
import (
|
||||
"bufio"
|
||||
"os"
|
||||
"regexp"
|
||||
"runtime"
|
||||
"strconv"
|
||||
"strings"
|
||||
@@ -142,17 +143,29 @@ func cpuFlagsFrom(path string) []string {
|
||||
// nvidiaDriverFrom reads the loaded kernel module's version, which exists
|
||||
// exactly when a driver is loaded — unlike nvidia-smi, which can be installed
|
||||
// on a machine whose module failed to load.
|
||||
var driverVersion = regexp.MustCompile(`^[0-9]+\.[0-9]+(\.[0-9]+)?$`)
|
||||
|
||||
func nvidiaDriverFrom(path string) string {
|
||||
b, err := os.ReadFile(path) //nolint:gosec // a fixed system path
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
// "NVRM version: NVIDIA UNIX x86_64 Kernel Module 570.86.15 Thu ..."
|
||||
// "NVRM version: NVIDIA UNIX x86_64 Kernel Module 570.86.15 Thu ...", or
|
||||
// for the open module, the default since 560, "NVIDIA UNIX Open Kernel
|
||||
// Module for x86_64 580.82.07 Release Build ...": the first version
|
||||
// after "Module", not the word after it. Read as "for", the driver was
|
||||
// unknown, and every build was tried whatever driver it needs.
|
||||
fields := strings.Fields(string(b))
|
||||
for i, f := range fields {
|
||||
if f == "Module" && i+1 < len(fields) {
|
||||
return fields[i+1]
|
||||
if f != "Module" {
|
||||
continue
|
||||
}
|
||||
for _, v := range fields[i+1:] {
|
||||
if driverVersion.MatchString(v) {
|
||||
return v
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
package discovery
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNVIDIADriverFrom(t *testing.T) {
|
||||
for _, tc := range []struct{ text, want string }{
|
||||
{"NVRM version: NVIDIA UNIX x86_64 Kernel Module 570.86.15 Thu Jan 23 21:30:38 UTC 2025\nGCC version: gcc version 12.2.0\n", "570.86.15"},
|
||||
{"NVRM version: NVIDIA UNIX Open Kernel Module for x86_64 580.82.07 Release Build (dvs-builder@U16-I3-B03-4-3) Wed Aug 27 00:51:12 UTC 2025\n", "580.82.07"},
|
||||
{"NVRM version: NVIDIA UNIX Open Kernel Module for aarch64 580.95.05 Release Build\n", "580.95.05"},
|
||||
{"NVRM version: NVIDIA UNIX x86_64 Kernel Module 535.54 Mon\n", "535.54"},
|
||||
{"something else\n", ""},
|
||||
} {
|
||||
p := filepath.Join(t.TempDir(), "version")
|
||||
if err := os.WriteFile(p, []byte(tc.text), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got := nvidiaDriverFrom(p); got != tc.want {
|
||||
t.Errorf("%q: got %q, want %q", tc.text, got, tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -124,10 +124,15 @@ func (c *ComfyUI) Commands(s ShardSpec) ([]Command, error) {
|
||||
if s.APIKey != "" {
|
||||
env["LLMGW_ENGINE_KEY"] = s.APIKey
|
||||
}
|
||||
// A model's custom nodes, which only the catalog sets — a profile's env
|
||||
// may not name the variable — and so taken before baseEnv drops it.
|
||||
if nodes := p.Env[comfyNodesEnv]; nodes != "" {
|
||||
env[comfyNodesEnv] = nodes
|
||||
// A model's custom nodes and the repository a node loads its weights by,
|
||||
// which only the catalog sets — a profile's env may not name them — and
|
||||
// so taken before baseEnv drops them. Without the repository the gate
|
||||
// links no Hugging Face cache, and sf3d's node went to the network for
|
||||
// its gated repository and was refused with a 401.
|
||||
for _, k := range []string{comfyNodesEnv, comfyHFRepoEnv, SharedModelsEnv} {
|
||||
if v := p.Env[k]; v != "" {
|
||||
env[k] = v
|
||||
}
|
||||
}
|
||||
return []Command{{Name: "comfyui", Path: bin, Args: args, Env: materializeEnv(env)}}, nil
|
||||
}
|
||||
@@ -135,3 +140,12 @@ func (c *ComfyUI) Commands(s ShardSpec) ([]Command, error) {
|
||||
// comfyNodesEnv is the custom nodes the catalog gives a ComfyUI model, as
|
||||
// JSON; catalog.NodesEnv and comfy.NodesEnv by the same name.
|
||||
const comfyNodesEnv = "LLMGW_COMFYUI_NODES"
|
||||
|
||||
// comfyHFRepoEnv is the repository a custom node loads the weights by name
|
||||
// from; catalog.HFRepoEnv and comfy.HFRepoEnv by the same name.
|
||||
const comfyHFRepoEnv = "LLMGW_COMFYUI_HF_REPO"
|
||||
|
||||
// SharedModelsEnv is a shared replica's members — name, source, and the
|
||||
// path the agent fetched it to — as JSON; catalog.SharedModelsEnv and
|
||||
// comfy.SharedModelsEnv by the same name.
|
||||
const SharedModelsEnv = "LLMGW_COMFYUI_MODELS"
|
||||
@@ -33,6 +33,25 @@ func TestComfyUIRunsBehindTheGateWithItsKeyOutOfSight(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheGateIsToldTheNodesAndTheRepositoryTheCatalogGives(t *testing.T) {
|
||||
// The repository was dropped on the way: sf3d's node went to the network
|
||||
// for its gated repository, with no cache linked, and got a 401.
|
||||
c := &ComfyUI{cfg: ComfyUIConfig{Dir: "/opt/comfyui"}}
|
||||
cmds, err := c.Commands(ShardSpec{
|
||||
ReplicaID: "r-sf3d-1", HTTPPort: 8100, BindAddr: "10.0.0.147", GPUIndices: []int{0},
|
||||
Profile: Profile{Name: "p", Engine: "comfyui", ModelPath: "/w/sf3d/", ServedModelName: "sf3d",
|
||||
Env: map[string]string{comfyNodesEnv: `[{"repo":"x"}]`, comfyHFRepoEnv: "stabilityai/stable-fast-3d"}},
|
||||
})
|
||||
if err != nil || len(cmds) != 1 {
|
||||
t.Fatalf("%v %v", cmds, err)
|
||||
}
|
||||
for _, want := range []string{comfyNodesEnv + `=[{"repo":"x"}]`, comfyHFRepoEnv + "=stabilityai/stable-fast-3d"} {
|
||||
if !slices.Contains(cmds[0].Env, want) {
|
||||
t.Errorf("%q not in the gate's environment", want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestComfyUIRunsOnOneCard(t *testing.T) {
|
||||
c := &ComfyUI{}
|
||||
if err := c.Validate(Profile{Name: "p", ModelPath: "/w", TP: 2}, h100(2)); err == nil {
|
||||
|
||||
@@ -91,6 +91,25 @@ func TestComfyUIOnAnOlderDriverTakesPyTorchsCUDA12Torch(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// A V100 on driver 580: CUDA 13 runs on the driver, but neither its torch
|
||||
// nor CUDA 12.9's has kernels for Volta. Tried in turn, each was installed,
|
||||
// 10 GB at a time, and failed on the card.
|
||||
func TestComfyUIOnAVoltaTakesPyTorchsCUDA126Torch(t *testing.T) {
|
||||
sys := &fakePython{fakeSystem: fakeSystem{installed: map[string]bool{}}}
|
||||
host := turingNode
|
||||
host.MinComputeCapability = 7.0
|
||||
in, rel := pythonInstaller(t, host, sys)
|
||||
comfyuiSource(t, in, rel, "")
|
||||
got := in.Converge(t.Context(), []Want{{Engine: "comfyui", Version: "0.39.2"}})
|
||||
if got[0].State != Ready || got[0].Variant != "cu126" {
|
||||
t.Fatalf("got %+v", got[0])
|
||||
}
|
||||
all := strings.Join(sys.commands, "\n")
|
||||
if !strings.Contains(all, pytorchCU126) || strings.Contains(all, pytorchCU129) {
|
||||
t.Errorf("torch is not CUDA 12.6's:\n%s", all)
|
||||
}
|
||||
}
|
||||
|
||||
func TestComfyUIWhoseSourceIsNotTheOneTheRecipeNamesIsNotInstalled(t *testing.T) {
|
||||
sys := &fakePython{fakeSystem: fakeSystem{installed: map[string]bool{}}}
|
||||
in, rel := pythonInstaller(t, turingNode, sys)
|
||||
@@ -130,3 +149,29 @@ func TestARequirementsFileIsReadForPackagesAndNothingElse(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// A card every build runs on keeps the order it had: a Turing node's
|
||||
// installed cu13 is still the first found, and is not installed again
|
||||
// because a build for older cards was added after it.
|
||||
func TestComfyUIBuildsAreTriedBestFirst(t *testing.T) {
|
||||
variants := func(h discovery.Host) string {
|
||||
builds, err := comfyuiCandidates("0.39.2", "", h)
|
||||
if err != nil {
|
||||
return err.Error()
|
||||
}
|
||||
var v []string
|
||||
for _, b := range builds {
|
||||
v = append(v, b.Variant)
|
||||
}
|
||||
return strings.Join(v, ",")
|
||||
}
|
||||
volta := turingNode
|
||||
volta.MinComputeCapability = 7.0
|
||||
older := turingNode
|
||||
older.NVIDIADriver = "550.163.01"
|
||||
for h, want := range map[*discovery.Host]string{&turingNode: "cu13,cu129,cu126", &volta: "cu126", &older: "cu129,cu126"} {
|
||||
if got := variants(*h); got != want {
|
||||
t.Errorf("cc %.1f driver %s: %s, want %s", h.MinComputeCapability, h.NVIDIADriver, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -592,6 +592,18 @@ var comfyuiReleases = map[string]struct {
|
||||
"0.39.2": {"1d655e22cf546700fc1d6d2536e27701695c5832a51f63bb16c41866ac09be0b", "2026-10-07T21:58:07Z"},
|
||||
}
|
||||
|
||||
// ComfyUIVersion is the newest ComfyUI this agent installs: what a cluster
|
||||
// is set to when a model first needs it.
|
||||
func ComfyUIVersion() string {
|
||||
newest := ""
|
||||
for v := range comfyuiReleases {
|
||||
if newest == "" || versionBefore(newest, v) {
|
||||
newest = v
|
||||
}
|
||||
}
|
||||
return newest
|
||||
}
|
||||
|
||||
// ComfyUIRepo is where ComfyUI's source is published.
|
||||
const ComfyUIRepo = "Comfy-Org/ComfyUI"
|
||||
|
||||
@@ -599,10 +611,15 @@ const ComfyUIRepo = "Comfy-Org/ComfyUI"
|
||||
// <environment>/comfyui/main.py, beside bin/python.
|
||||
const comfyuiDir = "comfyui"
|
||||
|
||||
// pytorchCU126 is PyTorch's CUDA 12.6 build: the last that carries kernels
|
||||
// for Volta and Pascal. From torch 2.8 its CUDA 12.8 and 12.9 builds start
|
||||
// at Turing (7.5), as CUDA 13 does, so a V100 has no torch but this one.
|
||||
const pytorchCU126 = "https://download.pytorch.org/whl/cu126"
|
||||
|
||||
// comfyuiCandidates are the ComfyUI builds for a machine: its source, in a
|
||||
// Python environment with the torch for the node's driver — PyPI's, built
|
||||
// for CUDA 13, or PyTorch's CUDA 12.9 build for a driver CUDA 13 does not
|
||||
// run on.
|
||||
// Python environment with the torch for the node's driver and cards —
|
||||
// PyPI's, built for CUDA 13; PyTorch's CUDA 12.9 build for a driver CUDA 13
|
||||
// does not run on; and its CUDA 12.6 build for cards older than Turing.
|
||||
func comfyuiCandidates(version, variant string, h discovery.Host) ([]Build, error) {
|
||||
if _, err := gpuArch("ComfyUI", h); err != nil {
|
||||
return nil, err
|
||||
@@ -647,8 +664,11 @@ print("comfyui version", "` + version + `", "on torch", torch.__version__)`},
|
||||
}
|
||||
cu129 := build("cu129")
|
||||
cu129.ExtraIndex, cu129.IndexPackages = pytorchCU129, pytorchPackages
|
||||
cu126 := build("cu126")
|
||||
cu126.ExtraIndex, cu126.IndexPackages = pytorchCU126, pytorchPackages
|
||||
return pick("ComfyUI "+version, variant, []candidate{
|
||||
{build("cu13"), gpuNeeds{minDriverForCUDA13, 7.5}, "ComfyUI " + version + " on CUDA 13's torch"},
|
||||
{cu129, gpuNeeds{minDriverForCUDA12, 7.0}, "ComfyUI " + version + " on CUDA 12.9's torch"},
|
||||
{cu129, gpuNeeds{minDriverForCUDA12, 7.5}, "ComfyUI " + version + " on CUDA 12.9's torch"},
|
||||
{cu126, gpuNeeds{minDriverForCUDA12, 5.0}, "ComfyUI " + version + " on CUDA 12.6's torch"},
|
||||
}, h)
|
||||
}
|
||||
@@ -243,6 +243,10 @@ var liveSettings = []string{
|
||||
"firewall", "firewall_networks",
|
||||
// Sent to the nodes' agents as they change.
|
||||
"agents",
|
||||
// Read by the leader's presets pass each time it runs.
|
||||
"presets",
|
||||
// Handed to the reconciler as they change.
|
||||
"on_demand",
|
||||
// Read by server init, node add and backups, not by the server.
|
||||
"backup_recipients", "backup_copy_to",
|
||||
}
|
||||
|
||||
@@ -268,6 +268,26 @@ func upgradeNodes(ctx context.Context, out io.Writer, client func() *ctlClient,
|
||||
}
|
||||
fmt.Fprintf(out, "%d node(s) upgraded to %s in %s, %d already on it\n",
|
||||
done, v, time.Since(start).Round(time.Second), skipped)
|
||||
// Checked at the end, against what the control plane says now: a node
|
||||
// that is not on the version is said by name, and the command fails. A
|
||||
// site's nodes stayed a release behind with nothing printed to say so.
|
||||
if len(nodes) == 0 {
|
||||
fmt.Fprintln(out, "This control plane has no nodes registered, so none were upgraded.")
|
||||
}
|
||||
var now []adminapi.NodeView
|
||||
if err := client().get(ctx, "/api/v1/nodes", &now); err == nil {
|
||||
var behind []string
|
||||
for _, n := range now {
|
||||
if (len(only) == 0 || slices.Contains(only, n.ID)) && n.AgentVersion != v {
|
||||
behind = append(behind, fmt.Sprintf("%s (%s, %s)", n.ID, orUnknown(n.AgentVersion), n.State))
|
||||
}
|
||||
}
|
||||
if len(behind) > 0 {
|
||||
slices.Sort(behind)
|
||||
return fmt.Errorf("not on %s: %s\nrun this again to try them, or `llmgw ctl logs NODE` for why",
|
||||
v, strings.Join(behind, ", "))
|
||||
}
|
||||
}
|
||||
// The one machine this does not reach. Said every time, because it is
|
||||
// exactly the kind of thing that stays three versions behind unnoticed.
|
||||
fmt.Fprintf(out, "The model mirror's host is not upgraded by this; on it, run:\n"+
|
||||
|
||||
@@ -150,3 +150,54 @@ func TestABinaryInstalledByHandIsNotAServerRunningIt(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnUpgradeThatFindsNoNodesSaysSo(t *testing.T) {
|
||||
// A site's nodes stayed a release behind with nothing printed to say
|
||||
// that none had been reached.
|
||||
f := &fakeFleet{versions: map[string]string{}}
|
||||
srv := f.server(t)
|
||||
var out bytes.Buffer
|
||||
if err := upgradeNodes(t.Context(), &out, func() *ctlClient { return newCtlClient(srv.URL) }, "v1.0.1", nil, time.Second, 1); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !strings.Contains(out.String(), "no nodes registered") {
|
||||
t.Errorf("output:\n%s", out.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnUpgradeFailsNamingANodeLeftBehind(t *testing.T) {
|
||||
// A node that joins, or comes back on its old binary, while the waves
|
||||
// run is found at the end rather than passed over.
|
||||
f := &fakeFleet{versions: map[string]string{"a": "v1.0.0"}}
|
||||
srv := f.server(t)
|
||||
late := func() *ctlClient {
|
||||
f.mu.Lock()
|
||||
if len(f.told) == 1 {
|
||||
f.versions["late"] = "v1.0.0"
|
||||
}
|
||||
f.mu.Unlock()
|
||||
return newCtlClient(srv.URL)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
err := upgradeNodes(t.Context(), &out, late, "v1.0.1", nil, 5*time.Second, 1)
|
||||
if err == nil || !strings.Contains(err.Error(), "late (v1.0.0, ready)") {
|
||||
t.Errorf("err %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpgradingAControlPlaneAloneSaysItsNodesWereNot(t *testing.T) {
|
||||
f := &fakeFleet{versions: map[string]string{"p-g1": "v1.0.0", "p-g3": "v1.0.1"}}
|
||||
srv := f.server(t)
|
||||
var out bytes.Buffer
|
||||
nodesLeftBehind(t.Context(), &out, newCtlClient(srv.URL), "v1.0.1")
|
||||
if !strings.Contains(out.String(), "1 of 2 node(s) are not on v1.0.1") ||
|
||||
!strings.Contains(out.String(), "ctl upgrade v1.0.1 --skip-control-plane") {
|
||||
t.Errorf("output:\n%s", out.String())
|
||||
}
|
||||
out.Reset()
|
||||
f.versions["p-g1"] = "v1.0.1"
|
||||
nodesLeftBehind(t.Context(), &out, newCtlClient(srv.URL), "v1.0.1")
|
||||
if out.Len() != 0 {
|
||||
t.Errorf("said something with every node on the version: %s", out.String())
|
||||
}
|
||||
}
|
||||
+67
-22
@@ -3,6 +3,7 @@ package cli
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"os/user"
|
||||
"slices"
|
||||
@@ -32,7 +33,7 @@ func newModelCmd(client func() *ctlClient, asJSON *bool) *cobra.Command {
|
||||
Use: "model",
|
||||
Short: "Add or remove models while the cluster is running",
|
||||
}
|
||||
c.AddCommand(newModelAddCmd(client), newModelRemoveCmd(client), newModelPlanCmd(client),
|
||||
c.AddCommand(newModelAddCmd(client), newModelPresetsCmd(client, asJSON), newModelRemoveCmd(client), newModelPlanCmd(client),
|
||||
newResourcesCmd(client), newClassCmd(client), newOwnerCmd(client),
|
||||
newTargetCmd(client, asJSON), newAdaptersCmd(client),
|
||||
newModelServeCmd(client), newModelUpdatesCmd(client, asJSON), newModelUpdateCmd(client),
|
||||
@@ -46,34 +47,56 @@ func newModelAddCmd(client func() *ctlClient) *cobra.Command {
|
||||
var path string
|
||||
var skipCheck bool
|
||||
c := &cobra.Command{
|
||||
Use: "add -f <file.yaml>",
|
||||
Short: "Add a model from a definition file",
|
||||
Long: "The definition is the same YAML a model takes in server.yaml, so an\n" +
|
||||
Use: "add PRESET | -f <file.yaml>",
|
||||
Short: "Add a model that comes with llmgw, or one from a definition file",
|
||||
Long: "A preset is a model that comes with llmgw, its workflow, nodes and licence\n" +
|
||||
"already found and tried: " + strings.Join(catalog.PresetNames(), ", ") + " (llmgw ctl model presets).\n" +
|
||||
"Adding a ComfyUI one also has the nodes install ComfyUI, when the cluster\n" +
|
||||
"has not been told otherwise.\n\n" +
|
||||
"A definition is the same YAML a model takes in server.yaml, so an\n" +
|
||||
"entry can be moved between the two by copying it.\n\n" +
|
||||
"The catalog is rebuilt and validated before anything is written, so a\n" +
|
||||
"definition that collides with an existing name, or names a fallback that\n" +
|
||||
"does not exist, is refused rather than stored and then ignored on every\n" +
|
||||
"start. Once accepted it takes effect on the reconciler's next pass — no\n" +
|
||||
"restart — and survives one.",
|
||||
Args: cobra.NoArgs,
|
||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||
if path == "" {
|
||||
return fmt.Errorf("--file is required: the model definition, as YAML")
|
||||
}
|
||||
// Read by koanf, the same parser and the same tags that read
|
||||
// server.yaml — so an entry can be moved between the two by copying
|
||||
// it, and a field that works in one cannot silently mean nothing in
|
||||
// the other.
|
||||
k := koanf.New(".")
|
||||
if err := k.Load(file.Provider(path), yaml.Parser()); err != nil {
|
||||
return fmt.Errorf("%s: %w", path, err)
|
||||
}
|
||||
Example: " llmgw ctl model add triposr\n" +
|
||||
" llmgw ctl model add -f qwen.yaml",
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
var m catalog.Model
|
||||
if err := k.UnmarshalWithConf("", &m, koanf.UnmarshalConf{Tag: "koanf"}); err != nil {
|
||||
return fmt.Errorf("%s: %w", path, err)
|
||||
}
|
||||
if m.Name == "" {
|
||||
return fmt.Errorf("%s: the definition has no name", path)
|
||||
switch {
|
||||
case len(args) == 1 && path != "":
|
||||
return fmt.Errorf("a preset or a file, not both")
|
||||
case len(args) == 1:
|
||||
p, ok := catalog.PresetNamed(args[0])
|
||||
if !ok {
|
||||
return fmt.Errorf("no preset %q: there are %s; any other model is added from a file (-f)",
|
||||
args[0], strings.Join(catalog.PresetNames(), ", "))
|
||||
}
|
||||
// The control plane adds it, and keeps that it was added as
|
||||
// a preset, by whom; one from before it could is sent the
|
||||
// entry, as it was then.
|
||||
var res adminapi.ModelAdded
|
||||
err := client().post(cmd.Context(), "/api/v1/presets/"+url.PathEscape(p.Model.Name), []byte("{}"), &res)
|
||||
if err == nil {
|
||||
fmt.Fprintf(cmd.OutOrStdout(),
|
||||
"%s added, and ComfyUI with it where the cluster had none. It is placed on the next\n"+
|
||||
"reconcile pass and loads when first asked for; watch it with:\n llmgw ctl models\n", p.Model.Name)
|
||||
return nil
|
||||
}
|
||||
if !olderControlPlane(err) {
|
||||
return err
|
||||
}
|
||||
m = p.Model
|
||||
case path == "":
|
||||
return fmt.Errorf("a preset (%s) or --file, the model definition as YAML",
|
||||
strings.Join(catalog.PresetNames(), ", "))
|
||||
default:
|
||||
var err error
|
||||
if m, err = readModelFile(path); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Before the catalog is touched, because a source that does not
|
||||
@@ -107,6 +130,9 @@ func newModelAddCmd(client func() *ctlClient) *cobra.Command {
|
||||
fmt.Fprintf(cmd.OutOrStdout(),
|
||||
"%s added. It will be placed on the next reconcile pass; watch it with:\n"+
|
||||
" llmgw ctl models\n", m.Name)
|
||||
if m.ServesComfyUI() && !m.IsExternal() {
|
||||
return ensureComfyUI(cmd, client, m.Name)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
@@ -116,6 +142,25 @@ func newModelAddCmd(client func() *ctlClient) *cobra.Command {
|
||||
return c
|
||||
}
|
||||
|
||||
// readModelFile reads a model's definition. By koanf, the same parser and
|
||||
// the same tags that read server.yaml — so an entry can be moved between the
|
||||
// two by copying it, and a field that works in one cannot silently mean
|
||||
// nothing in the other.
|
||||
func readModelFile(path string) (catalog.Model, error) {
|
||||
var m catalog.Model
|
||||
k := koanf.New(".")
|
||||
if err := k.Load(file.Provider(path), yaml.Parser()); err != nil {
|
||||
return m, fmt.Errorf("%s: %w", path, err)
|
||||
}
|
||||
if err := k.UnmarshalWithConf("", &m, koanf.UnmarshalConf{Tag: "koanf"}); err != nil {
|
||||
return m, fmt.Errorf("%s: %w", path, err)
|
||||
}
|
||||
if m.Name == "" {
|
||||
return m, fmt.Errorf("%s: the definition has no name", path)
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
func newModelRemoveCmd(client func() *ctlClient) *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "remove <name>",
|
||||
|
||||
@@ -0,0 +1,166 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/provision"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/settings"
|
||||
)
|
||||
|
||||
func newModelPresetsCmd(client func() *ctlClient, asJSON *bool) *cobra.Command {
|
||||
c := &cobra.Command{
|
||||
Use: "presets",
|
||||
Short: "The models that come with llmgw: whether each fits and is here",
|
||||
Long: "Each is a catalog entry whose workflow, custom nodes, packages and licence\n" +
|
||||
"were found and tried, and whose profile says the card it needs rather than\n" +
|
||||
"a class, so it places on any site's cards. Add one with\n" +
|
||||
"`llmgw ctl model add NAME`.\n\n" +
|
||||
"While presets.auto is on, the leader adds one by itself when a card fits it\n" +
|
||||
"and the catalog has nothing that makes what it makes; one somebody removed\n" +
|
||||
"is not added again by itself.",
|
||||
Args: cobra.NoArgs,
|
||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||
var v adminapi.PresetsView
|
||||
err := client().get(cmd.Context(), "/api/v1/presets", &v)
|
||||
if err != nil && !olderControlPlane(err) {
|
||||
return err
|
||||
}
|
||||
if *asJSON && err == nil {
|
||||
return emitJSON(v)
|
||||
}
|
||||
w := tabTo(cmd.OutOrStdout())
|
||||
if err != nil {
|
||||
// A control plane from before it kept them: what this
|
||||
// release has, with nothing about the cluster.
|
||||
fmt.Fprintln(w, "NAME\tMAKES\tCARD\tLICENCE\tWHAT IT IS FOR")
|
||||
for _, p := range catalog.Presets() {
|
||||
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", p.Model.Name, p.Makes, presetCard(p.Model),
|
||||
presetLicence(p.Model), p.Model.Description)
|
||||
}
|
||||
return w.Flush()
|
||||
}
|
||||
fmt.Fprintln(w, "NAME\tMAKES\tCARD\tLICENCE\tFITS\tHERE\tWHAT IT IS FOR")
|
||||
for _, p := range v.Presets {
|
||||
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\t%s\n", p.Name, p.Makes, p.Card, licenceText(p.Licence),
|
||||
orDash(strings.Join(p.FitsClasses, ",")), presetState(p), p.Description)
|
||||
}
|
||||
if err := w.Flush(); err != nil {
|
||||
return err
|
||||
}
|
||||
if v.Auto {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "\nAdded by themselves where a card fits (presets.auto); "+
|
||||
"llmgw ctl model presets auto off stops it.")
|
||||
} else {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "\nNot added by themselves; llmgw ctl model presets auto on starts it.")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
c.AddCommand(&cobra.Command{
|
||||
Use: "auto on|off",
|
||||
Short: "Whether the leader adds a preset by itself where a card fits it",
|
||||
Args: cobra.ExactArgs(1),
|
||||
ValidArgs: []string{"on", "off"},
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if args[0] != "on" && args[0] != "off" {
|
||||
return fmt.Errorf("on or off, not %q", args[0])
|
||||
}
|
||||
body, _ := json.Marshal(adminapi.PresetsAutoRequest{On: args[0] == "on"})
|
||||
var v adminapi.PresetsView
|
||||
if err := client().put(cmd.Context(), "/api/v1/presets/auto", body, &v); err != nil {
|
||||
return err
|
||||
}
|
||||
if v.Auto {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "Presets are added by themselves where a card fits.")
|
||||
} else {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "Presets are no longer added by themselves.")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
})
|
||||
return c
|
||||
}
|
||||
|
||||
// olderControlPlane is an error from a control plane that has no such path:
|
||||
// one from before it was added.
|
||||
func olderControlPlane(err error) bool {
|
||||
s := err.Error()
|
||||
return strings.Contains(s, "answered with a page") || strings.HasPrefix(s, "404 Not Found: 404 page not found")
|
||||
}
|
||||
|
||||
func presetState(p adminapi.PresetView) string {
|
||||
switch {
|
||||
case p.InCatalog && p.AddedBy == "auto":
|
||||
return "added by itself"
|
||||
case p.InCatalog && p.AddedBy != "":
|
||||
return "added by " + p.AddedBy
|
||||
case p.InCatalog:
|
||||
return "here"
|
||||
case p.Declined:
|
||||
return "removed; stays out"
|
||||
}
|
||||
return "—"
|
||||
}
|
||||
|
||||
func licenceText(l catalog.License) string {
|
||||
if l.Commercial != nil && !*l.Commercial {
|
||||
return l.Name + ", not commercial"
|
||||
}
|
||||
return l.Name
|
||||
}
|
||||
|
||||
func presetCard(m catalog.Model) string {
|
||||
if len(m.Profiles) == 0 || m.Profiles[0].GPU == nil {
|
||||
return "—"
|
||||
}
|
||||
return m.Profiles[0].GPU.String()
|
||||
}
|
||||
|
||||
func presetLicence(m catalog.Model) string {
|
||||
if m.License == nil {
|
||||
return "—"
|
||||
}
|
||||
l := m.License.Name
|
||||
if c := m.License.Commercial; c != nil && !*c {
|
||||
l += ", not commercial"
|
||||
}
|
||||
return l
|
||||
}
|
||||
|
||||
// ensureComfyUI has the nodes install ComfyUI for a model that needs it,
|
||||
// unless the cluster names a version already, or none on purpose.
|
||||
func ensureComfyUI(cmd *cobra.Command, client func() *ctlClient, model string) error {
|
||||
out := cmd.OutOrStdout()
|
||||
path := []string{"engines", catalog.EngineComfyUI}
|
||||
var cur adminapi.SettingsView
|
||||
if err := client().get(cmd.Context(), "/api/v1/settings", &cur); err != nil {
|
||||
return err
|
||||
}
|
||||
doc, err := settings.FromBytes("settings", []byte(cur.Body))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
version := provision.ComfyUIVersion()
|
||||
if n := doc.Node(path); n != nil {
|
||||
if n.Value == "" {
|
||||
fmt.Fprintf(out, "engines.comfyui is set to none, so the nodes install no ComfyUI for it: set a version "+
|
||||
"(llmgw ctl config set engines.comfyui %s) or name one installed by hand in agent.yaml\n", version)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
fmt.Fprintf(out, "Nodes with an NVIDIA GPU install ComfyUI %s for it, about 10 GB each:\n", version)
|
||||
if err := doc.SetYAML(path, version); err != nil {
|
||||
return err
|
||||
}
|
||||
b, err := doc.Bytes()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return putSettings(cmd, client, cur, b, "ComfyUI for "+model)
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
)
|
||||
|
||||
// presetAdmin is an admin API holding settings, which records the models
|
||||
// added and the settings put.
|
||||
type presetAdmin struct {
|
||||
// api is a control plane that adds presets itself; without it, one
|
||||
// from before, which answers their paths with a 404.
|
||||
api bool
|
||||
byAPI []string
|
||||
mu sync.Mutex
|
||||
settings string
|
||||
added []catalog.Model
|
||||
put []string
|
||||
}
|
||||
|
||||
func (a *presetAdmin) client(t *testing.T) func() *ctlClient {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
a.mu.Lock()
|
||||
defer a.mu.Unlock()
|
||||
body, _ := io.ReadAll(r.Body)
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
switch {
|
||||
case a.api && r.Method == http.MethodPost && strings.HasPrefix(r.URL.Path, "/api/v1/presets/"):
|
||||
name := strings.TrimPrefix(r.URL.Path, "/api/v1/presets/")
|
||||
a.byAPI = append(a.byAPI, name)
|
||||
_ = json.NewEncoder(w).Encode(adminapi.ModelAdded{Added: name})
|
||||
case r.Method == http.MethodPost && r.URL.Path == "/api/v1/models":
|
||||
var m catalog.Model
|
||||
_ = json.Unmarshal(body, &m)
|
||||
a.added = append(a.added, m)
|
||||
_ = json.NewEncoder(w).Encode(map[string]string{"name": m.Name})
|
||||
case r.Method == http.MethodGet && r.URL.Path == "/api/v1/settings":
|
||||
_ = json.NewEncoder(w).Encode(adminapi.SettingsView{Version: 1, Body: a.settings})
|
||||
case r.Method == http.MethodPut && r.URL.Path == "/api/v1/settings":
|
||||
var req adminapi.SettingsRequest
|
||||
_ = json.Unmarshal(body, &req)
|
||||
a.put = append(a.put, req.Body)
|
||||
a.settings = req.Body
|
||||
_ = json.NewEncoder(w).Encode(adminapi.SettingsView{Version: 2, Body: req.Body})
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
t.Cleanup(srv.Close)
|
||||
return func() *ctlClient { return newCtlClient(strings.TrimPrefix(srv.URL, "http://"), "") }
|
||||
}
|
||||
|
||||
func runModelAdd(t *testing.T, client func() *ctlClient, args ...string) (string, error) {
|
||||
t.Helper()
|
||||
cmd := newModelAddCmd(client)
|
||||
var out bytes.Buffer
|
||||
cmd.SetOut(&out)
|
||||
cmd.SetErr(&out)
|
||||
cmd.SetArgs(append(args, "--no-source-check"))
|
||||
err := cmd.ExecuteContext(t.Context())
|
||||
return out.String(), err
|
||||
}
|
||||
|
||||
func TestAPresetIsAddedByTheControlPlane(t *testing.T) {
|
||||
a := &presetAdmin{api: true}
|
||||
out, err := runModelAdd(t, a.client(t), "triposr")
|
||||
if err != nil {
|
||||
t.Fatalf("%v\n%s", err, out)
|
||||
}
|
||||
if len(a.byAPI) != 1 || a.byAPI[0] != "triposr" || len(a.added) != 0 || len(a.put) != 0 {
|
||||
t.Errorf("by the API %v; sent the entry %v; settings %v", a.byAPI, a.added, a.put)
|
||||
}
|
||||
}
|
||||
|
||||
// A control plane from before presets were its own is sent the entry, and
|
||||
// ComfyUI set beside it, as the release that brought presets did.
|
||||
func TestAPresetIsAddedByNameAndHasTheNodesInstallComfyUI(t *testing.T) {
|
||||
a := &presetAdmin{settings: "router:\n retries: 2\n"}
|
||||
out, err := runModelAdd(t, a.client(t), "triposr")
|
||||
if err != nil {
|
||||
t.Fatalf("%v\n%s", err, out)
|
||||
}
|
||||
if len(a.added) != 1 || a.added[0].Name != "triposr" || a.added[0].ComfyUI.Workflow != "triposr" {
|
||||
t.Fatalf("added %+v", a.added)
|
||||
}
|
||||
if len(a.put) != 1 || !strings.Contains(a.put[0], "comfyui: 0.39.2") || !strings.Contains(a.put[0], "retries: 2") {
|
||||
t.Fatalf("settings put %q", a.put)
|
||||
}
|
||||
if !strings.Contains(out, "install ComfyUI 0.39.2") {
|
||||
t.Errorf("not said:\n%s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAClusterThatNamesItsComfyUIKeepsIt(t *testing.T) {
|
||||
for _, settings := range []string{"engines:\n comfyui: 0.38.0\n", "engines:\n comfyui: \"\"\n"} {
|
||||
a := &presetAdmin{settings: settings}
|
||||
out, err := runModelAdd(t, a.client(t), "flux-schnell")
|
||||
if err != nil {
|
||||
t.Fatalf("%v\n%s", err, out)
|
||||
}
|
||||
if len(a.put) != 0 {
|
||||
t.Errorf("%q: settings changed to %q", settings, a.put)
|
||||
}
|
||||
if none := strings.Contains(settings, `""`); none != strings.Contains(out, "set to none") {
|
||||
t.Errorf("%q: %s", settings, out)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnUnknownPresetNamesTheOnesThereAre(t *testing.T) {
|
||||
a := &presetAdmin{}
|
||||
_, err := runModelAdd(t, a.client(t), "sdxl")
|
||||
if err == nil || !strings.Contains(err.Error(), "flux-schnell, triposr") || len(a.added) != 0 {
|
||||
t.Errorf("%v, added %v", err, a.added)
|
||||
}
|
||||
if _, err := runModelAdd(t, a.client(t), "triposr", "-f", "x.yaml"); err == nil {
|
||||
t.Error("a preset and a file were both taken")
|
||||
}
|
||||
}
|
||||
@@ -60,6 +60,8 @@ func newModelServeCmd(client func() *ctlClient) *cobra.Command {
|
||||
f.StringVar(&req.Quant, "quant", "", "the quantisation to serve (default: the one that suits the cluster best)")
|
||||
f.StringVar(&req.File, "file", "", "the file to serve, instead of choosing by --quant")
|
||||
f.StringVar(&req.Projector, "projector", "", "a vision model's mmproj file, fetched and loaded beside it")
|
||||
f.BoolVar(&req.Embeddings, "embeddings", false, "serve it as an embedding model (its GGUF header says so for most): "+
|
||||
"--embedding, 32 slots of 1024 tokens unless --ctx-pool or --context-length says otherwise")
|
||||
f.StringVar(&req.Format, "format", "gguf", "gguf, run by llama.cpp, or safetensors: the original weights, run by vLLM on GPUs")
|
||||
f.BoolVar(&req.CPU, "cpu", false, "run it on the CPU, whatever the plan says")
|
||||
f.StringVar(&req.GPUClass, "gpu-class", "", "run it on GPUs of this class, whatever the plan says")
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"io"
|
||||
"os"
|
||||
"os/exec"
|
||||
"runtime"
|
||||
@@ -70,6 +73,9 @@ func newSelfUpgradeCmd() *cobra.Command {
|
||||
if strings.TrimSpace(string(b)) == "active" {
|
||||
if steady++; steady >= 3 {
|
||||
fmt.Fprintf(out, "%s restarted and running\n", service)
|
||||
if service == "llmgw-server" {
|
||||
nodesLeftBehind(cmd.Context(), out, newCtlClient("127.0.0.1:9090"), v)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
} else {
|
||||
@@ -85,3 +91,25 @@ func newSelfUpgradeCmd() *cobra.Command {
|
||||
c.Flags().StringVar(&service, "service", "", "the systemd unit to restart afterwards, e.g. llmgw-mirror")
|
||||
return c
|
||||
}
|
||||
|
||||
// nodesLeftBehind says, after a control plane alone was upgraded, that its
|
||||
// nodes were not, and how they are: this command looks like the cluster's
|
||||
// upgrade and is not, and a site's nodes stayed a release behind after it.
|
||||
func nodesLeftBehind(ctx context.Context, out io.Writer, c *ctlClient, v string) {
|
||||
var nodes []adminapi.NodeView
|
||||
_ = c.patient(20*time.Second).get(ctx, "/api/v1/nodes", &nodes)
|
||||
behind := 0
|
||||
for _, n := range nodes {
|
||||
if n.AgentVersion != v {
|
||||
behind++
|
||||
}
|
||||
}
|
||||
switch {
|
||||
case len(nodes) == 0:
|
||||
fmt.Fprintf(out, "This upgraded this machine only. The nodes are upgraded from the leading "+
|
||||
"control plane with:\n sudo llmgw ctl upgrade %s --skip-control-plane\n", v)
|
||||
case behind > 0:
|
||||
fmt.Fprintf(out, "This upgraded this machine only: %d of %d node(s) are not on %s. On the leading "+
|
||||
"control plane, run:\n sudo llmgw ctl upgrade %s --skip-control-plane\n", behind, len(nodes), v, v)
|
||||
}
|
||||
}
|
||||
@@ -264,6 +264,7 @@ func newServerCmd() *cobra.Command {
|
||||
agentSvc = svc
|
||||
// Stopped by the operators (llmgw stop): nothing placed.
|
||||
ctl.Reconciler().SetStopped(cfg.Serving.Stopped)
|
||||
ctl.Reconciler().SetEvictionTimes(cfg.OnDemand.EvictAfterIdle, cfg.OnDemand.MinLifetime)
|
||||
// Whether nodes keep llmgw's firewall, as the settings say now.
|
||||
svc.SetFirewall(func() *llmgwv1.Firewall {
|
||||
c := current.Load()
|
||||
@@ -465,6 +466,14 @@ func newServerCmd() *cobra.Command {
|
||||
}
|
||||
api.SetModels(svc)
|
||||
catalogSvc = svc
|
||||
// The models that come with llmgw: added by the leader
|
||||
// when a node fits one and the catalog makes nothing of
|
||||
// its kind, unless somebody removed it or turned it off.
|
||||
api.SetPresets(st, func() adminapi.PresetConfig {
|
||||
c := current.Load()
|
||||
return adminapi.PresetConfig{Auto: c.Presets.Auto, ComfyUI: c.Engines[catalog.EngineComfyUI]}
|
||||
})
|
||||
go runPresetsPass(ctx, api, admin.Leadership(), log)
|
||||
// And the mirror page, so a model that has just been
|
||||
// fetched can be served without writing YAML by hand.
|
||||
rt.SetCatalogAdmin(svc)
|
||||
@@ -770,6 +779,9 @@ func newServerCmd() *cobra.Command {
|
||||
fwPub.Kick()
|
||||
}
|
||||
}
|
||||
if slices.ContainsFunc(changed, func(c string) bool { return strings.HasPrefix(c, "on_demand") }) && admin != nil {
|
||||
admin.Reconciler().SetEvictionTimes(next.OnDemand.EvictAfterIdle, next.OnDemand.MinLifetime)
|
||||
}
|
||||
if slices.ContainsFunc(changed, func(c string) bool { return strings.HasPrefix(c, "agents") }) && agentSvc != nil {
|
||||
// A moment apart per node, so off this goroutine.
|
||||
go agentSvc.BroadcastAgentSettings()
|
||||
@@ -1281,3 +1293,32 @@ func embedder(replay func(ctx context.Context, path, model string, body []byte)
|
||||
return res.Data[0].Embedding, nil
|
||||
}
|
||||
}
|
||||
|
||||
// presetsEvery is how often the leader looks for presets to add; the first
|
||||
// look waits as long, for the nodes to have registered their cards.
|
||||
const presetsEvery = time.Minute
|
||||
|
||||
// runPresetsPass has the leader add the presets a node fits and the catalog
|
||||
// lacks, now and then.
|
||||
func runPresetsPass(ctx context.Context, api *adminapi.API, lead *control.Leadership, log *slog.Logger) {
|
||||
t := time.NewTicker(presetsEvery)
|
||||
defer t.Stop()
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return
|
||||
case <-t.C:
|
||||
}
|
||||
if lead != nil && !lead.IsLeader() {
|
||||
continue
|
||||
}
|
||||
added, err := api.PresetsPass(ctx)
|
||||
for _, name := range added {
|
||||
log.Info("added a preset by itself: a node fits it and the catalog made nothing of its kind",
|
||||
"model", name, "off_switch", "presets.auto")
|
||||
}
|
||||
if err != nil {
|
||||
log.Warn("could not add a preset", "err", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -73,6 +73,9 @@ type serverInit struct {
|
||||
// patroni are user@host of the machines to keep the store on under
|
||||
// Patroni, replicated; this machine is the third etcd vote for two.
|
||||
patroni []string
|
||||
// webhooks are where the cluster's alerts go: put into its settings
|
||||
// once it runs, and each sent a test.
|
||||
webhooks []string
|
||||
// patroniNodes are the same machines already connected to, which the
|
||||
// setup screen does with the password it was given; when set, patroni
|
||||
// only names them.
|
||||
@@ -182,6 +185,9 @@ func newServerInitCmd() *cobra.Command {
|
||||
"leave the firewall alone, instead of keeping llmgw's internal ports to the cluster's networks")
|
||||
f.BoolVar(&in.postgres, "postgres", false,
|
||||
"keep the store in PostgreSQL on this machine, installing it and moving an existing SQLite store into it")
|
||||
f.StringArrayVar(&in.webhooks, "webhook", nil,
|
||||
"where alerts go — a model parked, a node lost, a budget spent: an http(s) address, Slack's, Mattermost's "+
|
||||
"and Rocket.Chat's sent Slack's text, any other the event as JSON (slack: or json: in front says which); repeatable")
|
||||
f.StringArrayVar(&in.patroni, "patroni", nil,
|
||||
"user@host of a machine to keep the store on, replicated under Patroni; give two or more. "+
|
||||
"Installs PostgreSQL, Patroni and etcd there over ssh, and moves the existing store in")
|
||||
@@ -249,6 +255,9 @@ func (in *serverInit) run(ctx context.Context) error {
|
||||
fmt.Fprintf(in.out, " !! firewall: %v; llmgw's ports answer every network this machine is on\n", err)
|
||||
}
|
||||
}
|
||||
if err := in.ensureWebhooks(ctx); err != nil {
|
||||
fmt.Fprintf(in.out, " !! webhooks: %v\n", err)
|
||||
}
|
||||
if in.judgeWanted() && in.configJudgesWith(guardModelName) {
|
||||
// Not fatal: without its judge the baseline policy still checks for
|
||||
// secrets and injection, and a judged request is served flagged.
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"slices"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"go.yaml.in/yaml/v3"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/notify"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/settings"
|
||||
)
|
||||
|
||||
// Where the cluster says what went wrong: a model parked, a node lost, a
|
||||
// budget spent. notify.webhooks existed, and setup never asked for one, so a
|
||||
// site learnt of a lost node from its users.
|
||||
|
||||
// parseWebhook reads a webhook as setup takes it: an address, with "slack:"
|
||||
// or "json:" in front to say what it is sent, else what its address says.
|
||||
func parseWebhook(s string) (notify.Webhook, error) {
|
||||
s = strings.TrimSpace(s)
|
||||
format := ""
|
||||
for _, f := range []string{"slack", "json"} {
|
||||
if rest, ok := strings.CutPrefix(s, f+":"); ok && !strings.HasPrefix(rest, "//") {
|
||||
format, s = f, rest
|
||||
}
|
||||
}
|
||||
u, err := url.Parse(s)
|
||||
if err != nil || (u.Scheme != "https" && u.Scheme != "http") || u.Host == "" {
|
||||
return notify.Webhook{}, fmt.Errorf("webhook %q: an http(s) address, with slack: or json: in front to say its format", s)
|
||||
}
|
||||
if format == "" {
|
||||
format = webhookFormat(u)
|
||||
}
|
||||
return notify.Webhook{URL: s, Format: format}, nil
|
||||
}
|
||||
|
||||
// webhookFormat is what an address takes: Slack's own, and the incoming
|
||||
// webhooks that read Slack's {"text": …} — Mattermost's and Rocket.Chat's
|
||||
// /hooks/, Discord's …/slack — are sent that; anything else the event as
|
||||
// JSON.
|
||||
func webhookFormat(u *url.URL) string {
|
||||
switch {
|
||||
case u.Host == "hooks.slack.com",
|
||||
strings.Contains(u.Path, "/hooks/"),
|
||||
strings.HasSuffix(u.Path, "/slack"):
|
||||
return "slack"
|
||||
}
|
||||
return "json"
|
||||
}
|
||||
|
||||
// parseWebhooks reads a list of them, by commas or as given.
|
||||
func parseWebhooks(list []string) ([]notify.Webhook, error) {
|
||||
var out []notify.Webhook
|
||||
for _, item := range list {
|
||||
for _, s := range strings.Split(item, ",") {
|
||||
if strings.TrimSpace(s) == "" {
|
||||
continue
|
||||
}
|
||||
w, err := parseWebhook(s)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, w)
|
||||
}
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// webhookEntry is one of notify.webhooks as the settings document has it.
|
||||
type webhookEntry struct {
|
||||
URL string `yaml:"url"`
|
||||
Format string `yaml:"format,omitempty"`
|
||||
Events []string `yaml:"events,omitempty,flow"`
|
||||
SecretFile string `yaml:"secret_file,omitempty"`
|
||||
}
|
||||
|
||||
// withWebhooks adds these webhooks to a settings document's notify.webhooks,
|
||||
// and says whether that changed it: one already there, by address, is left
|
||||
// as it is, with whatever events and secret it was given.
|
||||
func withWebhooks(doc *settings.Doc, add []notify.Webhook) (bool, error) {
|
||||
path := []string{"notify", "webhooks"}
|
||||
var list []webhookEntry
|
||||
if n := doc.Node(path); n != nil {
|
||||
if err := n.Decode(&list); err != nil {
|
||||
return false, fmt.Errorf("notify.webhooks in the cluster's settings: %w", err)
|
||||
}
|
||||
}
|
||||
changed := false
|
||||
for _, w := range add {
|
||||
if !slices.ContainsFunc(list, func(e webhookEntry) bool { return e.URL == w.URL }) {
|
||||
list = append(list, webhookEntry{URL: w.URL, Format: w.Format})
|
||||
changed = true
|
||||
}
|
||||
}
|
||||
if !changed {
|
||||
return false, nil
|
||||
}
|
||||
b, err := yaml.Marshal(list)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return true, doc.SetYAML(path, string(b))
|
||||
}
|
||||
|
||||
// ensureWebhooks puts the webhooks given into the cluster's settings and
|
||||
// sends each a test, once the control plane runs on them. Said, not fatal: a
|
||||
// cluster without its alerts still serves.
|
||||
func (in *serverInit) ensureWebhooks(ctx context.Context) error {
|
||||
if len(in.webhooks) == 0 {
|
||||
return nil
|
||||
}
|
||||
hooks, err := parseWebhooks(in.webhooks)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
c := in.adminAPI()
|
||||
var cur adminapi.SettingsView
|
||||
if err := c.get(ctx, "/api/v1/settings", &cur); err != nil {
|
||||
return err
|
||||
}
|
||||
doc, err := settings.FromBytes("settings", []byte(cur.Body))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
changed, err := withWebhooks(doc, hooks)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if changed {
|
||||
b, err := doc.Bytes()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req, _ := json.Marshal(adminapi.SettingsRequest{Base: cur.Version, Body: string(b), Note: "notification webhooks, from setup"})
|
||||
if err := c.put(ctx, "/api/v1/settings", req, &cur); err != nil {
|
||||
return err
|
||||
}
|
||||
in.done("notification webhooks in the cluster's settings (version %d)", cur.Version)
|
||||
} else {
|
||||
in.kept("notification webhooks (already in the cluster's settings)")
|
||||
}
|
||||
|
||||
// The control planes start again on the change; the test is sent by
|
||||
// one that knows every webhook asked for.
|
||||
var res []notify.Result
|
||||
err = waitFor(ctx, 2*time.Minute, "the control plane to run on its webhooks", func() (bool, error) {
|
||||
res = nil
|
||||
if c.post(ctx, "/api/v1/notify/test", nil, &res) != nil {
|
||||
return false, nil
|
||||
}
|
||||
for _, w := range hooks {
|
||||
// Answered by host: the path of a webhook is its secret.
|
||||
if !slices.ContainsFunc(res, func(r notify.Result) bool { return r.URL == notify.Redact(w.URL) }) {
|
||||
return false, nil
|
||||
}
|
||||
}
|
||||
return true, nil
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
var failed []string
|
||||
for _, r := range res {
|
||||
if !slices.ContainsFunc(hooks, func(w notify.Webhook) bool { return notify.Redact(w.URL) == r.URL }) {
|
||||
continue
|
||||
}
|
||||
if r.Err != "" {
|
||||
failed = append(failed, r.URL+": "+r.Err)
|
||||
continue
|
||||
}
|
||||
in.done("a test notification reached %s", r.URL)
|
||||
}
|
||||
if len(failed) > 0 {
|
||||
return errors.New("a test notification did not arrive: " + strings.Join(failed, "; ") +
|
||||
" (kept in the settings: 'llmgw ctl notify test' tries again)")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/notify"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/settings"
|
||||
)
|
||||
|
||||
func TestAWebhooksFormatIsWhatItsAddressTakes(t *testing.T) {
|
||||
for in, want := range map[string]string{
|
||||
"https://hooks.slack.com/services/T1/B2/abc": "slack",
|
||||
"https://chat.example.com/hooks/xyz": "slack", // Mattermost, Rocket.Chat
|
||||
"https://discord.com/api/webhooks/1/abc/slack": "slack",
|
||||
"https://alerts.example.com/llmgw": "json",
|
||||
"json:https://hooks.slack.com/services/T1/B2/abc": "json",
|
||||
"slack:https://alerts.example.com/llmgw": "slack",
|
||||
" https://events.pagerduty.com/integration/x/enqueue ": "json",
|
||||
} {
|
||||
w, err := parseWebhook(in)
|
||||
if err != nil || w.Format != want || strings.HasPrefix(w.URL, "slack:") || strings.HasPrefix(w.URL, "json:") {
|
||||
t.Errorf("%q: %+v %v, want %s", in, w, err, want)
|
||||
}
|
||||
}
|
||||
for _, bad := range []string{"hooks.slack.com/x", "ftp://example.com/x", "slack:", "https://"} {
|
||||
if _, err := parseWebhook(bad); err == nil {
|
||||
t.Errorf("%q was taken", bad)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestWebhooksAreAddedToTheSettingsBesideTheOnesThere(t *testing.T) {
|
||||
doc, err := settings.FromBytes("settings", []byte("router:\n retries: 2\nnotify:\n webhooks:\n"+
|
||||
" - url: https://alerts.example.com/a\n events: [node_lost]\n secret_file: /etc/llmgw/secrets/hook\n"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
hooks, _ := parseWebhooks([]string{"https://alerts.example.com/a, https://hooks.slack.com/services/T/B/c"})
|
||||
changed, err := withWebhooks(doc, hooks)
|
||||
if err != nil || !changed {
|
||||
t.Fatalf("changed %v: %v", changed, err)
|
||||
}
|
||||
b, _ := doc.Bytes()
|
||||
got := string(b)
|
||||
for _, want := range []string{"retries: 2", "url: https://alerts.example.com/a", "events: [node_lost]",
|
||||
"secret_file: /etc/llmgw/secrets/hook", "url: https://hooks.slack.com/services/T/B/c", "format: slack"} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Errorf("%q not in:\n%s", want, got)
|
||||
}
|
||||
}
|
||||
if strings.Count(got, "alerts.example.com/a") != 1 {
|
||||
t.Errorf("a webhook already there was added again:\n%s", got)
|
||||
}
|
||||
if changed, _ := withWebhooks(doc, hooks); changed {
|
||||
t.Error("adding the same webhooks again changed the settings")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetupPutsItsWebhooksInTheSettingsAndTestsThemOnceInForce(t *testing.T) {
|
||||
var mu sync.Mutex
|
||||
body, tests := "router:\n retries: 2\n", 0
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
switch {
|
||||
case r.Method == http.MethodGet && r.URL.Path == "/api/v1/settings":
|
||||
_ = json.NewEncoder(w).Encode(adminapi.SettingsView{Version: 1, Body: body})
|
||||
case r.Method == http.MethodPut && r.URL.Path == "/api/v1/settings":
|
||||
var req adminapi.SettingsRequest
|
||||
_ = json.NewDecoder(r.Body).Decode(&req)
|
||||
body = req.Body
|
||||
_ = json.NewEncoder(w).Encode(adminapi.SettingsView{Version: 2, Body: body})
|
||||
case r.Method == http.MethodPost && r.URL.Path == "/api/v1/notify/test":
|
||||
tests++
|
||||
// The first answer comes from the control plane before it
|
||||
// started again on the change: it knows no webhooks.
|
||||
res := []notify.Result{}
|
||||
if tests > 1 {
|
||||
res = []notify.Result{{URL: notify.Redact("https://hooks.slack.com/services/T/B/c")},
|
||||
{URL: notify.Redact("https://ops.example.com/in"), Err: "502 Bad Gateway"}}
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(res)
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer srv.Close()
|
||||
dir := t.TempDir()
|
||||
if err := os.WriteFile(filepath.Join(dir, "server.yaml"),
|
||||
[]byte("admin_listen: "+strings.TrimPrefix(srv.URL, "http://")+"\n"), 0o600); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var out bytes.Buffer
|
||||
in := &serverInit{etcDir: dir, out: &out,
|
||||
webhooks: []string{"https://hooks.slack.com/services/T/B/c", "https://ops.example.com/in"}}
|
||||
err := in.ensureWebhooks(t.Context())
|
||||
if err == nil || !strings.Contains(err.Error(), "502") || !strings.Contains(err.Error(), "ctl notify test") {
|
||||
t.Errorf("a webhook that did not answer: %v", err)
|
||||
}
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
if !strings.Contains(body, "format: slack") || !strings.Contains(body, "url: https://ops.example.com/in") ||
|
||||
!strings.Contains(body, "retries: 2") || tests < 2 {
|
||||
t.Errorf("settings %q after %d tests", body, tests)
|
||||
}
|
||||
if strings.Contains(out.String(), "/services/T/B/c") {
|
||||
t.Errorf("a webhook's secret path was printed:\n%s", out.String())
|
||||
}
|
||||
if !strings.Contains(out.String(), "reached https://hooks.slack.com/…") {
|
||||
t.Errorf("the one that answered is not said:\n%s", out.String())
|
||||
}
|
||||
}
|
||||
@@ -90,7 +90,10 @@ type consoleData struct {
|
||||
// federation is the other llmgw clusters whose models are offered
|
||||
// here; empty on a control plane without a store.
|
||||
federation adminapi.FederationView
|
||||
err error
|
||||
// presets is the models that come with llmgw as they stand here; nil
|
||||
// from a control plane that cannot say.
|
||||
presets *adminapi.PresetsView
|
||||
err error
|
||||
}
|
||||
|
||||
type (
|
||||
@@ -275,6 +278,10 @@ func (m consoleModel) fetch() tea.Cmd {
|
||||
_ = c.get(ctx, "/api/v1/jobs", &d.jobs)
|
||||
_ = c.get(ctx, "/api/v1/audit?since=7d&limit=300", &d.audit)
|
||||
_ = c.get(ctx, "/api/v1/federation", &d.federation)
|
||||
var presets adminapi.PresetsView
|
||||
if c.get(ctx, "/api/v1/presets", &presets) == nil {
|
||||
d.presets = &presets
|
||||
}
|
||||
return consoleDataMsg(d)
|
||||
}
|
||||
}
|
||||
@@ -599,6 +606,10 @@ func (m consoleModel) key(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
m.hf.models, m.hf.err, m.row = nil, nil, 0
|
||||
return m, m.fetchHF()
|
||||
}
|
||||
case "p":
|
||||
if m.menu == cModels && m.inPanel && m.data.presets != nil {
|
||||
m.autoPresetsConfirm()
|
||||
}
|
||||
case "a":
|
||||
switch m.menu {
|
||||
case cQuotas:
|
||||
@@ -1237,9 +1248,13 @@ func (m consoleModel) panel() (title, body, keys string) {
|
||||
strings.Join(md.Profiles, ","), upd, warn})
|
||||
}
|
||||
if m.inPanel {
|
||||
keys = "↑↓ row · Enter actions · A add from a file · ← back · Q leave"
|
||||
keys = "↑↓ row · Enter actions · A add a model · ← back · Q leave"
|
||||
if m.data.presets != nil {
|
||||
keys = "↑↓ row · Enter actions · A add a model · P pictures and 3D added by themselves · ← back · Q leave"
|
||||
}
|
||||
}
|
||||
return "Models", "\n" + table([]string{"MODEL", "READY", "STATUS", "CLASS", "PROFILES", "UPDATE", ""}, rows, m.row, pw, m.inPanel), keys
|
||||
return "Models", "\n" + table([]string{"MODEL", "READY", "STATUS", "CLASS", "PROFILES", "UPDATE", ""}, rows, m.row, pw, m.inPanel) +
|
||||
presetsBlock(m.data.presets, pw), keys
|
||||
case cReplicas:
|
||||
var rows [][]string
|
||||
for _, r := range m.data.replicas {
|
||||
|
||||
@@ -50,6 +50,7 @@ func (w *lineWriter) Write(p []byte) (int, error) {
|
||||
const (
|
||||
fAdmin = iota
|
||||
fHosts
|
||||
fWebhooks
|
||||
fPostgres
|
||||
fMirror
|
||||
fNode
|
||||
@@ -70,6 +71,7 @@ type initModel struct {
|
||||
focus int
|
||||
admin textField
|
||||
hosts textField
|
||||
webhooks textField
|
||||
bundle textField
|
||||
bundleSHA textField
|
||||
toggles [fCount]bool
|
||||
@@ -103,6 +105,11 @@ func newInitModel(in *serverInit, found []string, askForm bool) initModel {
|
||||
hosts.SetValue(strings.Join(in.hosts, ", "))
|
||||
hosts.CharLimit = 400
|
||||
hosts.Width = 40
|
||||
webhooks := newTextField()
|
||||
webhooks.Placeholder = "https://hooks.slack.com/services/…"
|
||||
webhooks.SetValue(strings.Join(in.webhooks, ", "))
|
||||
webhooks.CharLimit = 800
|
||||
webhooks.Width = 40
|
||||
bundle := newTextField()
|
||||
bundle.Placeholder = "/media/usb/llmgw-bundle.tar"
|
||||
bundle.SetValue(in.bundle)
|
||||
@@ -114,7 +121,7 @@ func newInitModel(in *serverInit, found []string, askForm bool) initModel {
|
||||
bundleSHA.CharLimit = 64
|
||||
bundleSHA.Width = 64
|
||||
sp := newSpinner()
|
||||
m := initModel{in: in, found: found, form: askForm, admin: admin, hosts: hosts,
|
||||
m := initModel{in: in, found: found, form: askForm, admin: admin, hosts: hosts, webhooks: webhooks,
|
||||
bundle: bundle, bundleSHA: bundleSHA, spin: sp, width: 100}
|
||||
m.toggles[fPostgres] = in.postgres
|
||||
m.toggles[fMirror] = !in.noMirror
|
||||
@@ -235,6 +242,17 @@ func (m initModel) formKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
m.moveFocus(0)
|
||||
return m, nil
|
||||
}
|
||||
hooks := strings.TrimSpace(m.webhooks.Value())
|
||||
if _, err := parseWebhooks([]string{hooks}); err != nil {
|
||||
m.formError = err.Error()
|
||||
m.focus = fWebhooks
|
||||
m.moveFocus(0)
|
||||
return m, nil
|
||||
}
|
||||
m.in.webhooks = nil
|
||||
if hooks != "" {
|
||||
m.in.webhooks = []string{hooks}
|
||||
}
|
||||
m.in.bundle, m.in.bundleSHA = bundle, sum
|
||||
m.in.admin = admin
|
||||
m.in.hosts = nil
|
||||
@@ -260,6 +278,10 @@ func (m initModel) formKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
var cmd tea.Cmd
|
||||
m.hosts, cmd = m.hosts.Update(k)
|
||||
return m, cmd
|
||||
case fWebhooks:
|
||||
var cmd tea.Cmd
|
||||
m.webhooks, cmd = m.webhooks.Update(k)
|
||||
return m, cmd
|
||||
case fBundle:
|
||||
var cmd tea.Cmd
|
||||
m.bundle, cmd = m.bundle.Update(k)
|
||||
@@ -284,6 +306,7 @@ func (m *initModel) moveFocus(d int) {
|
||||
}
|
||||
m.admin.Blur()
|
||||
m.hosts.Blur()
|
||||
m.webhooks.Blur()
|
||||
m.bundle.Blur()
|
||||
m.bundleSHA.Blur()
|
||||
switch m.focus {
|
||||
@@ -291,6 +314,8 @@ func (m *initModel) moveFocus(d int) {
|
||||
m.admin.Focus()
|
||||
case fHosts:
|
||||
m.hosts.Focus()
|
||||
case fWebhooks:
|
||||
m.webhooks.Focus()
|
||||
case fBundle:
|
||||
m.bundle.Focus()
|
||||
case fBundleSHA:
|
||||
@@ -409,6 +434,8 @@ func (m initModel) formView() string {
|
||||
found = strings.Join(m.found, ", ")
|
||||
}
|
||||
b.WriteString(" " + sDim.Render("Already in the certificate: "+found+". Add a DNS name or NAT address here.") + "\n\n")
|
||||
fmt.Fprintf(&b, "%s\n %s\n", label(fWebhooks, "Notification webhooks"), m.webhooks.View())
|
||||
b.WriteString(" " + sDim.Render("Where a parked model, a lost node or a spent budget is said: Slack, Mattermost, or any URL taking JSON. Comma-separated; a test is sent.") + "\n\n")
|
||||
b.WriteString(check(fPostgres, "PostgreSQL", "rather than SQLite; installed here, for several control planes or a larger store"))
|
||||
if m.in.mirrorURL != "" {
|
||||
b.WriteString(" Model mirror " + sDim.Render("at "+m.in.mirrorURL+", from --mirror") + "\n")
|
||||
|
||||
@@ -20,6 +20,8 @@ func TestTheInitFormBecomesInitsSettings(t *testing.T) {
|
||||
m = typeIn(m, "ops@example.com")
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab})
|
||||
m = typeIn(m, "llm.example.com, 203.0.113.10")
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab})
|
||||
m = typeIn(m, "https://hooks.slack.com/services/T1/B2/x, json:https://alerts.example.com/in")
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune(" ")}) // PostgreSQL on
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab},
|
||||
tea.KeyMsg{Type: tea.KeyRunes, Runes: []rune(" ")}) // starter model off
|
||||
@@ -33,11 +35,30 @@ func TestTheInitFormBecomesInitsSettings(t *testing.T) {
|
||||
if !in.postgres || in.noMirror || in.noNode || !in.noModel || !in.noGuardModel {
|
||||
t.Errorf("toggles: postgres %v mirror %v node %v model %v", in.postgres, !in.noMirror, !in.noNode, !in.noModel)
|
||||
}
|
||||
if hooks, err := parseWebhooks(in.webhooks); err != nil || len(hooks) != 2 || hooks[0].Format != "slack" || hooks[1].Format != "json" {
|
||||
t.Errorf("webhooks %q: %+v %v", in.webhooks, hooks, err)
|
||||
}
|
||||
if m.(initModel).form {
|
||||
t.Error("the form stayed up after Set up")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAWebhookThatIsNoAddressKeepsTheFormUp(t *testing.T) {
|
||||
in := &serverInit{}
|
||||
var m tea.Model = newInitModel(in, nil, true)
|
||||
for range fWebhooks {
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab})
|
||||
}
|
||||
m = typeIn(m, "hooks.slack.com/services/x")
|
||||
for range fStart - fWebhooks {
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab})
|
||||
}
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyEnter})
|
||||
if !m.(initModel).form || m.(initModel).focus != fWebhooks || !strings.Contains(m.View(), "http(s) address") {
|
||||
t.Errorf("an address without its scheme was taken:\n%s", m.View())
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnOfflineBundleIsGivenInTheFormWithItsDigest(t *testing.T) {
|
||||
in := &serverInit{}
|
||||
var m tea.Model = newInitModel(in, nil, true)
|
||||
@@ -117,9 +138,10 @@ func TestWithAMirrorElsewhereTheFormDoesNotOfferOne(t *testing.T) {
|
||||
if v := m.View(); !strings.Contains(v, "at http://10.0.0.150:8082, from --mirror") {
|
||||
t.Errorf("the mirror in use is not shown:\n%s", v)
|
||||
}
|
||||
// Tab from the addresses goes past the mirror line to PostgreSQL, then
|
||||
// the node.
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab})
|
||||
// Tab from the addresses goes to the webhooks, past the mirror line to
|
||||
// PostgreSQL, then the node.
|
||||
m = send(m, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab}, tea.KeyMsg{Type: tea.KeyTab},
|
||||
tea.KeyMsg{Type: tea.KeyTab})
|
||||
if f := m.(initModel).focus; f != fNode {
|
||||
t.Errorf("focus %d, want the node toggle %d", f, fNode)
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ import (
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/config"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/mirror"
|
||||
)
|
||||
|
||||
@@ -253,19 +254,42 @@ func (m consoleModel) mirrorPanel(pw int) (string, string, string) {
|
||||
return "Mirror", head + table([]string{"MODEL", "VERSION", "FILE", "STATE", "SIZE", "USED BY"}, rows, m.row, pw, m.inPanel), keys
|
||||
}
|
||||
|
||||
// addModelForm adds a model from a definition file on this machine: the
|
||||
// same YAML a model takes in server.yaml.
|
||||
// fromFile is the add-model choice that reads a definition file rather
|
||||
// than naming a preset.
|
||||
const fromFile = "from a file"
|
||||
|
||||
// addModelForm adds a model that comes with llmgw, or one from a definition
|
||||
// file on this machine: the same YAML a model takes in server.yaml.
|
||||
func (m *consoleModel) addModelForm() {
|
||||
server := "--server=" + m.client.base
|
||||
var note strings.Builder
|
||||
note.WriteString("A model that comes with llmgw, tried and with its licence:\n")
|
||||
for _, p := range catalog.Presets() {
|
||||
fmt.Fprintf(¬e, " %s: %s, %s, %s\n", p.Model.Name, p.Makes, presetCard(p.Model), presetLicence(p.Model))
|
||||
}
|
||||
note.WriteString("A ComfyUI one has the nodes install ComfyUI if the cluster has none.\n" +
|
||||
"Or a definition file: the YAML a model takes in server.yaml's models.")
|
||||
var choices []string
|
||||
for _, n := range catalog.PresetNames() {
|
||||
choices = append(choices, presetChoice(m.data.presets, n))
|
||||
}
|
||||
m.openForm(&formDialog{title: "Add a model",
|
||||
note: "From a definition file on this machine: the YAML a model takes in\nserver.yaml's models. Serve a model, under Do, needs none.",
|
||||
note: note.String(),
|
||||
fields: []formField{
|
||||
textF("file", "", "like /root/qwen.yaml"),
|
||||
choiceF("model", append(choices, fromFile), choices[0]),
|
||||
textF("file", "", "for "+fromFile+": like /root/qwen.yaml"),
|
||||
},
|
||||
submit: func(m *consoleModel, v []string) (tea.Cmd, error) {
|
||||
if _, err := os.Stat(v[0]); err != nil {
|
||||
if v[0] != fromFile {
|
||||
// The name, without what the choice says beside it.
|
||||
return m.addPreset(strings.Fields(v[0])[0]), nil
|
||||
}
|
||||
if v[1] == "" {
|
||||
return nil, fmt.Errorf("a file, or a model that comes with llmgw")
|
||||
}
|
||||
if _, err := os.Stat(v[1]); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return m.runCLI("Add a model", "ctl", server, "model", "add", "-f", v[0]), nil
|
||||
return m.runCLI("Add a model", "ctl", server, "model", "add", "-f", v[1]), nil
|
||||
}})
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
)
|
||||
|
||||
// presetsBlock is the models that come with llmgw, under the models table:
|
||||
// whether each fits a card here and whether it is in the catalog, and
|
||||
// whether the leader adds them by itself. Empty from a control plane that
|
||||
// cannot say.
|
||||
func presetsBlock(v *adminapi.PresetsView, width int) string {
|
||||
if v == nil || len(v.Presets) == 0 {
|
||||
return ""
|
||||
}
|
||||
var rows [][]string
|
||||
var why []string
|
||||
for _, p := range v.Presets {
|
||||
rows = append(rows, []string{p.Name, p.Makes, orDash(strings.Join(p.FitsClasses, ",")), presetState(p)})
|
||||
// Why the leader leaves it, under the table: a reason is longer than
|
||||
// any column the panel has room for. Automatic adding being off is
|
||||
// said once, below.
|
||||
if p.Blocked != "" && !strings.HasPrefix(p.Blocked, "presets.auto") && !p.Declined {
|
||||
why = append(why, " "+wrap(p.Name+": "+p.Blocked, width-4, " "))
|
||||
}
|
||||
}
|
||||
auto := "Added by themselves where a card fits · P stops that"
|
||||
if !v.Auto {
|
||||
auto = "Not added by themselves · P starts that · A adds one"
|
||||
}
|
||||
out := "\n\n Pictures and 3D models that come with llmgw\n" +
|
||||
table([]string{"PRESET", "MAKES", "FITS", "HERE"}, rows, -1, width, false)
|
||||
if len(why) > 0 {
|
||||
out += "\n" + sDim.Render(strings.Join(why, "\n"))
|
||||
}
|
||||
return out + "\n " + sDim.Render(auto)
|
||||
}
|
||||
|
||||
// presetChoice is how a preset is offered in the add dialog: its name, and
|
||||
// where it stands when that is worth knowing before choosing it.
|
||||
func presetChoice(v *adminapi.PresetsView, name string) string {
|
||||
if v == nil {
|
||||
return name
|
||||
}
|
||||
for _, p := range v.Presets {
|
||||
if p.Name != name {
|
||||
continue
|
||||
}
|
||||
switch {
|
||||
case p.InCatalog:
|
||||
return name + " (already here)"
|
||||
case presetAddsComfyUI(v, p):
|
||||
return name + " (installs ComfyUI too)"
|
||||
case !p.Fits:
|
||||
return name + " (no card here fits it)"
|
||||
case p.Declined:
|
||||
return name + " (removed before)"
|
||||
}
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
// presetAddsComfyUI is whether adding a preset by hand also sets
|
||||
// engines.comfyui, which has the GPU nodes install it and the control planes
|
||||
// restart on the setting.
|
||||
func presetAddsComfyUI(v *adminapi.PresetsView, p adminapi.PresetView) bool {
|
||||
return v != nil && !p.InCatalog && v.ComfyUI == ""
|
||||
}
|
||||
|
||||
// addPreset adds a preset through the control plane, or, from one from
|
||||
// before it could, the way the release that brought presets did. One whose
|
||||
// adding installs ComfyUI and restarts the control planes is asked about
|
||||
// first.
|
||||
func (m *consoleModel) addPreset(name string) tea.Cmd {
|
||||
if m.data.presets != nil {
|
||||
for _, p := range m.data.presets.Presets {
|
||||
if p.Name == name && presetAddsComfyUI(m.data.presets, p) {
|
||||
m.confirmD = &confirmDialog{title: "Add " + name + " and ComfyUI",
|
||||
text: "The cluster installs no ComfyUI yet. Adding " + name + " sets engines.comfyui:\n" +
|
||||
"every GPU node installs it, about 10 GB each, and the control planes restart\n" +
|
||||
"on the setting, standbys first. Engines keep serving.",
|
||||
yes: func(m *consoleModel) tea.Cmd { return m.postPreset(name) }}
|
||||
return nil
|
||||
}
|
||||
}
|
||||
}
|
||||
return m.postPreset(name)
|
||||
}
|
||||
|
||||
func (m *consoleModel) postPreset(name string) tea.Cmd {
|
||||
if m.data.presets == nil {
|
||||
return m.runCLI("Add "+name, "ctl", "--server="+m.client.base, "model", "add", name)
|
||||
}
|
||||
return m.call("Add "+name, http.MethodPost, "/api/v1/presets/"+url.PathEscape(name), map[string]string{},
|
||||
func(_ json.RawMessage) string {
|
||||
return name + " is added, and ComfyUI with it where the cluster had none.\n" +
|
||||
"It is placed on the next pass, and loads when first asked for."
|
||||
})
|
||||
}
|
||||
|
||||
// autoPresetsConfirm turns the adding of presets by themselves on or off,
|
||||
// after saying what that does.
|
||||
func (m *consoleModel) autoPresetsConfirm() {
|
||||
on := !m.data.presets.Auto
|
||||
title, text := "Stop adding pictures and 3D models by themselves",
|
||||
"Presets already added stay. A preset is added only when somebody adds it."
|
||||
if on {
|
||||
title, text = "Add pictures and 3D models by themselves",
|
||||
"Where a card fits one and the catalog has nothing that makes what it makes, the leader adds it.\n"+
|
||||
"That also has every GPU node install ComfyUI, about 10 GB each, and the mirror fetch its weights.\n"+
|
||||
"A preset somebody removed is not added again."
|
||||
}
|
||||
m.confirmD = &confirmDialog{title: title, text: text, yes: func(m *consoleModel) tea.Cmd {
|
||||
return m.call(title, http.MethodPut, "/api/v1/presets/auto", adminapi.PresetsAutoRequest{On: on},
|
||||
func(_ json.RawMessage) string {
|
||||
if on {
|
||||
return "Presets are added by themselves where a card fits."
|
||||
}
|
||||
return "Presets are no longer added by themselves."
|
||||
})
|
||||
}}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
)
|
||||
|
||||
func presetsHere() *adminapi.PresetsView {
|
||||
return &adminapi.PresetsView{Auto: true, Presets: []adminapi.PresetView{
|
||||
{Name: "flux-schnell", Makes: "pictures", Card: "cc 7.0+, 24 GB+", Fits: true, FitsClasses: []string{"v100-32g"},
|
||||
Blocked: "the cluster installs no ComfyUI (engines.comfyui); adding it by hand sets that"},
|
||||
{Name: "triposr", Makes: "meshes", Card: "cc 7.0+, 8 GB+", Fits: true, InCatalog: true, AddedBy: "auto"},
|
||||
}}
|
||||
}
|
||||
|
||||
func TestThePresetsAreOnTheModelsScreen(t *testing.T) {
|
||||
m, _ := consoleWith(t, cModels)
|
||||
m.data.presets = presetsHere()
|
||||
v := m.View()
|
||||
for _, want := range []string{"Pictures and 3D models that come with llmgw", "flux-schnell", "v100-32g",
|
||||
"installs no ComfyUI", "added by itself", "P pictures and 3D"} {
|
||||
if !strings.Contains(v, want) {
|
||||
t.Errorf("%q not shown:\n%s", want, v)
|
||||
}
|
||||
}
|
||||
// A control plane that cannot say shows none of it.
|
||||
m.data.presets = nil
|
||||
if v := m.View(); strings.Contains(v, "come with llmgw") || strings.Contains(v, "P pictures") {
|
||||
t.Errorf("presets shown from nothing:\n%s", v)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPresetThatInstallsComfyUIIsAddedOnlyWhenConfirmed(t *testing.T) {
|
||||
m, s := consoleWith(t, cModels)
|
||||
m.data.presets = presetsHere()
|
||||
var tm tea.Model = m
|
||||
tm = press(tm, "a")
|
||||
f := tm.(consoleModel).formD
|
||||
if f == nil || !strings.Contains(f.fields[0].value(), "installs ComfyUI too") {
|
||||
t.Fatalf("no add dialog saying what flux-schnell brings: %+v", f)
|
||||
}
|
||||
tm = press(tm, "enter", "enter", "enter")
|
||||
if tm.(consoleModel).confirmD == nil || s.last() != "" {
|
||||
t.Fatalf("added without asking: %q", s.last())
|
||||
}
|
||||
tm = pressRun(tm, "y")
|
||||
if got := s.last(); got != "POST /api/v1/presets/flux-schnell {}" {
|
||||
t.Fatalf("sent %q", got)
|
||||
}
|
||||
|
||||
tm = press(tm, "esc", "p") // past what the add said
|
||||
if c := tm.(consoleModel).confirmD; c == nil || !strings.HasPrefix(c.title, "Stop adding") {
|
||||
t.Fatalf("P did not ask to stop: %+v", c)
|
||||
}
|
||||
_ = pressRun(tm, "y")
|
||||
if got := s.last(); got != `PUT /api/v1/presets/auto {"on":false}` {
|
||||
t.Fatalf("sent %q", got)
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,7 @@ import (
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
|
||||
joinpkg "gitea.mynodes.xyz/ilker/llmgw/internal/join"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/notify"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/onboard"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/pgha"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/preflight"
|
||||
@@ -150,8 +151,8 @@ type setupModel struct {
|
||||
ips []string
|
||||
choice int // 0 one machine, 1 high availability
|
||||
|
||||
admin, names textField
|
||||
afocus int // admin, names, next
|
||||
admin, names, webhooks textField
|
||||
afocus int // admin, names, webhooks, next
|
||||
|
||||
db [2]dbMachine
|
||||
mfocus int // over both machines' fields, then the check button
|
||||
@@ -184,8 +185,10 @@ func newSetupModel(host string, ips []string) setupModel {
|
||||
admin.Placeholder, admin.CharLimit, admin.Width = "you@example.com", 200, 40
|
||||
names := newTextField()
|
||||
names.Placeholder, names.CharLimit, names.Width = "llm.example.com, 203.0.113.10", 400, 40
|
||||
webhooks := newTextField()
|
||||
webhooks.Placeholder, webhooks.CharLimit, webhooks.Width = "https://hooks.slack.com/services/…", 800, 40
|
||||
return setupModel{
|
||||
ref: &progRef{}, host: host, ips: ips, admin: admin, names: names,
|
||||
ref: &progRef{}, host: host, ips: ips, admin: admin, names: names, webhooks: webhooks,
|
||||
db: [2]dbMachine{newDBMachine(1), newDBMachine(2)}, spin: newSpinner(), width: 100, height: 30,
|
||||
log: &[]string{}, logMu: &sync.Mutex{},
|
||||
}
|
||||
@@ -308,14 +311,17 @@ func (m setupModel) key(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
|
||||
func (m setupModel) adminKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
move := func(d int) {
|
||||
m.afocus = (m.afocus + d + 3) % 3
|
||||
m.afocus = (m.afocus + d + 4) % 4
|
||||
m.admin.Blur()
|
||||
m.names.Blur()
|
||||
m.webhooks.Blur()
|
||||
switch m.afocus {
|
||||
case 0:
|
||||
m.admin.Focus()
|
||||
case 1:
|
||||
m.names.Focus()
|
||||
case 2:
|
||||
m.webhooks.Focus()
|
||||
}
|
||||
}
|
||||
switch k.Type {
|
||||
@@ -326,7 +332,7 @@ func (m setupModel) adminKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
move(-1)
|
||||
return m, nil
|
||||
case tea.KeyEnter:
|
||||
if m.afocus < 2 {
|
||||
if m.afocus < 3 {
|
||||
move(1)
|
||||
return m, nil
|
||||
}
|
||||
@@ -336,6 +342,12 @@ func (m setupModel) adminKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
move(0)
|
||||
return m, nil
|
||||
}
|
||||
if _, err := parseWebhooks(m.webhookList()); err != nil {
|
||||
m.formErr = err.Error()
|
||||
m.afocus = 2
|
||||
move(0)
|
||||
return m, nil
|
||||
}
|
||||
m.formErr = ""
|
||||
m.page, m.mfocus = pMachines, 0
|
||||
m.db[0].addr.Focus()
|
||||
@@ -347,10 +359,23 @@ func (m setupModel) adminKey(k tea.KeyMsg) (tea.Model, tea.Cmd) {
|
||||
m.admin, cmd = m.admin.Update(k)
|
||||
case 1:
|
||||
m.names, cmd = m.names.Update(k)
|
||||
case 2:
|
||||
m.webhooks, cmd = m.webhooks.Update(k)
|
||||
}
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
// webhookList is the webhooks asked for, one an item.
|
||||
func (m setupModel) webhookList() []string {
|
||||
var out []string
|
||||
for _, s := range strings.Split(m.webhooks.Value(), ",") {
|
||||
if s = strings.TrimSpace(s); s != "" {
|
||||
out = append(out, s)
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func (m *setupModel) focusMachine() {
|
||||
for i := range m.db {
|
||||
for f := 0; f < mfCount; f++ {
|
||||
@@ -589,6 +614,9 @@ func (m setupModel) command() string {
|
||||
for _, t := range m.targets() {
|
||||
parts = append(parts, "--patroni "+t)
|
||||
}
|
||||
for _, w := range m.webhookList() {
|
||||
parts = append(parts, "--webhook "+w)
|
||||
}
|
||||
parts = append(parts, "--no-node", "--no-model")
|
||||
return strings.Join(parts, " \\\n ")
|
||||
}
|
||||
@@ -600,6 +628,7 @@ func (m *setupModel) startRun() tea.Cmd {
|
||||
in.admin = strings.TrimSpace(m.admin.Value())
|
||||
in.hosts = m.namesList()
|
||||
in.patroni = m.targets()
|
||||
in.webhooks = m.webhookList()
|
||||
// The control plane of a replicated setup is not where models run;
|
||||
// nodes are added once it is up.
|
||||
in.noNode, in.noModel = true, true
|
||||
@@ -759,7 +788,9 @@ func (m setupModel) adminView() string {
|
||||
sDim.Render("A password is generated and shown once, at the end."))
|
||||
fmt.Fprintf(&b, "%s\n %s\n %s\n\n", label(1, "Other names nodes will reach this machine by"), m.names.View(),
|
||||
sDim.Render("Known: "+strings.Join(append([]string{m.host}, m.ips...), ", ")+". Add a DNS name or a floating address."))
|
||||
b.WriteString(button(m.afocus == 2, "Next") + "\n")
|
||||
fmt.Fprintf(&b, "%s\n %s\n %s\n\n", label(2, "Notification webhooks"), m.webhooks.View(),
|
||||
sDim.Render("Where a parked model, a lost node or a spent budget is said: Slack, Mattermost, or any URL taking JSON. Optional; a test is sent."))
|
||||
b.WriteString(button(m.afocus == 3, "Next") + "\n")
|
||||
return b.String()
|
||||
}
|
||||
|
||||
@@ -880,6 +911,13 @@ func (m setupModel) planView() string {
|
||||
fmt.Fprintf(&b, " %s %s\n %s\n", lipgloss.NewStyle().Bold(true).Render(m.host), sDim.Render(m.thisAddr()),
|
||||
"control plane and gateway, model mirror, etcd (the third vote)")
|
||||
fmt.Fprintf(&b, " administrator %s\n", strings.TrimSpace(m.admin.Value()))
|
||||
if hooks, _ := parseWebhooks(m.webhookList()); len(hooks) > 0 {
|
||||
var where []string
|
||||
for _, h := range hooks {
|
||||
where = append(where, notify.Redact(h.URL)+" ("+h.Format+")")
|
||||
}
|
||||
fmt.Fprintf(&b, " alerts to %s\n", strings.Join(where, ", "))
|
||||
}
|
||||
granted := false
|
||||
for _, d := range m.db {
|
||||
addr := strings.TrimSpace(d.addr.Value())
|
||||
|
||||
@@ -45,7 +45,7 @@ func TestTheSetupAsksForWhatHighAvailabilityNeedsAndRefusesWhatWillNotDo(t *test
|
||||
t.Fatalf("high availability did not lead to the administrator: page %d", s.page)
|
||||
}
|
||||
// No email: refused, with a reason.
|
||||
m = press(m, "tab", "tab", "enter")
|
||||
m = press(m, "tab", "tab", "tab", "enter")
|
||||
if s := m.(setupModel); s.page != pAdmin || !strings.Contains(s.formErr, "email") {
|
||||
t.Fatalf("went on without an administrator: %+v", s.formErr)
|
||||
}
|
||||
@@ -54,7 +54,7 @@ func TestTheSetupAsksForWhatHighAvailabilityNeedsAndRefusesWhatWillNotDo(t *test
|
||||
if !strings.Contains(m.View(), "Not yet") {
|
||||
t.Error("the refusal was not shown as a dialog")
|
||||
}
|
||||
m = press(m, "x", "a@example.com", "tab", "tab", "enter")
|
||||
m = press(m, "x", "a@example.com", "tab", "tab", "tab", "enter")
|
||||
s := m.(setupModel)
|
||||
if s.page != pMachines {
|
||||
t.Fatalf("page %d: %s", s.page, s.formErr)
|
||||
|
||||
@@ -0,0 +1,526 @@
|
||||
// Package clientapi describes the API clients use, the one on :8080 — OpenAI's
|
||||
// shape and what llmgw adds to it — for its OpenAPI document.
|
||||
//
|
||||
// The types here are the bodies as they go over the wire, written for the
|
||||
// document: the handlers read a request's routing fields and pass the rest
|
||||
// to the engine as it came, so a request may carry more than is listed, and
|
||||
// an engine's answer may say more than is listed. The route table is checked
|
||||
// against the router's own by a test, so an endpoint cannot be added without
|
||||
// being described.
|
||||
package clientapi
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
// Error is every refusal: OpenAI's shape.
|
||||
type Error struct {
|
||||
Error ErrorBody `json:"error"`
|
||||
}
|
||||
|
||||
// ErrorBody says why.
|
||||
type ErrorBody struct {
|
||||
Message string `json:"message"`
|
||||
// Type is invalid_request_error, server_error, rate_limit_exceeded …
|
||||
Type string `json:"type"`
|
||||
// Code, where there is one a client branches on: model_not_found,
|
||||
// content_policy_violation, job_not_found, system_stopped.
|
||||
Code *string `json:"code"`
|
||||
}
|
||||
|
||||
// ChatMessage is one turn.
|
||||
type ChatMessage struct {
|
||||
// Role is system, user, assistant or tool.
|
||||
Role string `json:"role"`
|
||||
// Content is a string, or a list of parts: text, and image_url for a
|
||||
// model with vision.
|
||||
Content json.RawMessage `json:"content"`
|
||||
Name string `json:"name,omitempty"`
|
||||
ToolCalls json.RawMessage `json:"tool_calls,omitempty"`
|
||||
ToolCallID string `json:"tool_call_id,omitempty"`
|
||||
}
|
||||
|
||||
// StreamOptions asks for usage in the last chunk of a stream.
|
||||
type StreamOptions struct {
|
||||
IncludeUsage bool `json:"include_usage"`
|
||||
}
|
||||
|
||||
// ChatCompletionRequest is a chat turn asked of a model.
|
||||
type ChatCompletionRequest struct {
|
||||
// Model is a model's name or alias, or an adapter's name.
|
||||
Model string `json:"model"`
|
||||
Messages []ChatMessage `json:"messages"`
|
||||
// Stream answers as server-sent events.
|
||||
Stream bool `json:"stream,omitempty"`
|
||||
StreamOptions *StreamOptions `json:"stream_options,omitempty"`
|
||||
MaxTokens int `json:"max_tokens,omitempty"`
|
||||
MaxCompletionTokens int `json:"max_completion_tokens,omitempty"`
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
TopP *float64 `json:"top_p,omitempty"`
|
||||
Seed *int64 `json:"seed,omitempty"`
|
||||
// Stop is a string or a list of them.
|
||||
Stop json.RawMessage `json:"stop,omitempty"`
|
||||
Tools json.RawMessage `json:"tools,omitempty"`
|
||||
ToolChoice json.RawMessage `json:"tool_choice,omitempty"`
|
||||
ResponseFormat json.RawMessage `json:"response_format,omitempty"`
|
||||
// User is the client's own name for whoever it serves, kept with the
|
||||
// usage.
|
||||
User string `json:"user,omitempty"`
|
||||
// Metadata are tags kept with the usage, never sent to the engine.
|
||||
Metadata map[string]string `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
// Usage is what a request used.
|
||||
type Usage struct {
|
||||
PromptTokens int `json:"prompt_tokens"`
|
||||
CompletionTokens int `json:"completion_tokens"`
|
||||
TotalTokens int `json:"total_tokens"`
|
||||
}
|
||||
|
||||
// ChatChoice is one answer.
|
||||
type ChatChoice struct {
|
||||
Index int `json:"index"`
|
||||
Message ChatMessage `json:"message"`
|
||||
// FinishReason is stop, length or tool_calls.
|
||||
FinishReason string `json:"finish_reason"`
|
||||
}
|
||||
|
||||
// ChatCompletion is a model's answer.
|
||||
type ChatCompletion struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Created int64 `json:"created"`
|
||||
Model string `json:"model"`
|
||||
Choices []ChatChoice `json:"choices"`
|
||||
Usage Usage `json:"usage"`
|
||||
}
|
||||
|
||||
// CompletionRequest is a prompt to continue.
|
||||
type CompletionRequest struct {
|
||||
Model string `json:"model"`
|
||||
// Prompt is a string or a list of them.
|
||||
Prompt json.RawMessage `json:"prompt"`
|
||||
MaxTokens int `json:"max_tokens,omitempty"`
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
Stream bool `json:"stream,omitempty"`
|
||||
Stop json.RawMessage `json:"stop,omitempty"`
|
||||
Seed *int64 `json:"seed,omitempty"`
|
||||
}
|
||||
|
||||
// CompletionChoice is one continuation.
|
||||
type CompletionChoice struct {
|
||||
Index int `json:"index"`
|
||||
Text string `json:"text"`
|
||||
FinishReason string `json:"finish_reason"`
|
||||
}
|
||||
|
||||
// Completion is a continued prompt.
|
||||
type Completion struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Created int64 `json:"created"`
|
||||
Model string `json:"model"`
|
||||
Choices []CompletionChoice `json:"choices"`
|
||||
Usage Usage `json:"usage"`
|
||||
}
|
||||
|
||||
// EmbeddingRequest asks for vectors.
|
||||
type EmbeddingRequest struct {
|
||||
Model string `json:"model"`
|
||||
// Input is a string or a list of them; each is embedded on its own, and
|
||||
// the longest must fit the model's context.
|
||||
Input json.RawMessage `json:"input"`
|
||||
EncodingFormat string `json:"encoding_format,omitempty"`
|
||||
Dimensions int `json:"dimensions,omitempty"`
|
||||
}
|
||||
|
||||
// Embedding is one input's vector.
|
||||
type Embedding struct {
|
||||
Object string `json:"object"`
|
||||
Index int `json:"index"`
|
||||
Embedding []float64 `json:"embedding"`
|
||||
}
|
||||
|
||||
// EmbeddingList is every input's vector.
|
||||
type EmbeddingList struct {
|
||||
Object string `json:"object"`
|
||||
Data []Embedding `json:"data"`
|
||||
Model string `json:"model"`
|
||||
Usage Usage `json:"usage"`
|
||||
}
|
||||
|
||||
// RerankRequest orders documents by a query, for a reranker vLLM serves.
|
||||
type RerankRequest struct {
|
||||
Model string `json:"model"`
|
||||
Query string `json:"query"`
|
||||
Documents []string `json:"documents"`
|
||||
TopN int `json:"top_n,omitempty"`
|
||||
}
|
||||
|
||||
// ScoreRequest scores pairs of texts, for a scorer vLLM serves.
|
||||
type ScoreRequest struct {
|
||||
Model string `json:"model"`
|
||||
// TextA and TextB are strings or lists of them.
|
||||
TextA json.RawMessage `json:"text_1"`
|
||||
TextB json.RawMessage `json:"text_2"`
|
||||
}
|
||||
|
||||
// TranscriptionForm is speech to text, sent as a form.
|
||||
type TranscriptionForm struct {
|
||||
// File is the audio.
|
||||
File []byte `json:"file"`
|
||||
Model string `json:"model"`
|
||||
Language string `json:"language,omitempty"`
|
||||
Prompt string `json:"prompt,omitempty"`
|
||||
ResponseFormat string `json:"response_format,omitempty"`
|
||||
Temperature float64 `json:"temperature,omitempty"`
|
||||
}
|
||||
|
||||
// Transcription is the text.
|
||||
type Transcription struct {
|
||||
Text string `json:"text"`
|
||||
}
|
||||
|
||||
// ImageRequest asks for pictures, of a model that makes them.
|
||||
type ImageRequest struct {
|
||||
Model string `json:"model"`
|
||||
Prompt string `json:"prompt"`
|
||||
// N is how many, at most 4.
|
||||
N int `json:"n,omitempty"`
|
||||
// Size is WIDTHxHEIGHT, each a multiple of 16 from 256 to 2048.
|
||||
Size string `json:"size,omitempty"`
|
||||
// ResponseFormat is b64_json, the only one offered.
|
||||
ResponseFormat string `json:"response_format,omitempty"`
|
||||
Seed *int64 `json:"seed,omitempty"`
|
||||
Steps int `json:"steps,omitempty"`
|
||||
NegativePrompt string `json:"negative_prompt,omitempty"`
|
||||
Guidance *float64 `json:"guidance,omitempty"`
|
||||
}
|
||||
|
||||
// Image is one picture.
|
||||
type Image struct {
|
||||
B64JSON string `json:"b64_json"`
|
||||
}
|
||||
|
||||
// ImagesResponse is the pictures made; x-llmgw-seed says the seed.
|
||||
type ImagesResponse struct {
|
||||
Created int64 `json:"created"`
|
||||
Data []Image `json:"data"`
|
||||
}
|
||||
|
||||
// ModerationRequest asks the guardrails' judge.
|
||||
type ModerationRequest struct {
|
||||
// Input is a string or up to 32 of them.
|
||||
Input json.RawMessage `json:"input"`
|
||||
Model string `json:"model,omitempty"`
|
||||
}
|
||||
|
||||
// ModerationResult is one input's verdict.
|
||||
type ModerationResult struct {
|
||||
Flagged bool `json:"flagged"`
|
||||
Categories map[string]bool `json:"categories"`
|
||||
CategoryScores map[string]float64 `json:"category_scores"`
|
||||
}
|
||||
|
||||
// ModerationResponse is every input's verdict.
|
||||
type ModerationResponse struct {
|
||||
ID string `json:"id"`
|
||||
Model string `json:"model"`
|
||||
Results []ModerationResult `json:"results"`
|
||||
}
|
||||
|
||||
// ResponsesRequest is OpenAI's Responses API, translated to chat completions.
|
||||
type ResponsesRequest struct {
|
||||
Model string `json:"model"`
|
||||
// Input is a string or a list of items: messages, function calls and
|
||||
// their outputs.
|
||||
Input json.RawMessage `json:"input"`
|
||||
Instructions string `json:"instructions,omitempty"`
|
||||
Stream bool `json:"stream,omitempty"`
|
||||
Tools json.RawMessage `json:"tools,omitempty"`
|
||||
// Text carries format: a JSON schema the answer follows.
|
||||
Text json.RawMessage `json:"text,omitempty"`
|
||||
MaxOutputTokens int `json:"max_output_tokens,omitempty"`
|
||||
}
|
||||
|
||||
// MessagesRequest is Anthropic's Messages API, translated to chat completions.
|
||||
type MessagesRequest struct {
|
||||
Model string `json:"model"`
|
||||
Messages json.RawMessage `json:"messages"`
|
||||
System json.RawMessage `json:"system,omitempty"`
|
||||
MaxTokens int `json:"max_tokens"`
|
||||
Stream bool `json:"stream,omitempty"`
|
||||
Tools json.RawMessage `json:"tools,omitempty"`
|
||||
}
|
||||
|
||||
// TokenCount is how many tokens a Messages request would be.
|
||||
type TokenCount struct {
|
||||
InputTokens int `json:"input_tokens"`
|
||||
}
|
||||
|
||||
// License is the terms what a model makes comes under.
|
||||
type License struct {
|
||||
// ID is SPDX where there is one, else the licence's own short name.
|
||||
ID string `json:"id,omitempty"`
|
||||
Name string `json:"name"`
|
||||
URL string `json:"url,omitempty"`
|
||||
Notice string `json:"notice,omitempty"`
|
||||
// Commercial is whether the output may be used commercially; absent is
|
||||
// not said.
|
||||
Commercial *bool `json:"commercial,omitempty"`
|
||||
// ExcludedRegions are ISO 3166 codes, EU for the union, where it grants
|
||||
// nothing.
|
||||
ExcludedRegions []string `json:"excluded_regions,omitempty"`
|
||||
RevenueCapUSD int64 `json:"revenue_cap_usd,omitempty"`
|
||||
Attribution string `json:"attribution,omitempty"`
|
||||
}
|
||||
|
||||
// WorkflowInfo is what a ComfyUI model takes and makes, for a run at
|
||||
// /v1/workflows/runs.
|
||||
type WorkflowInfo struct {
|
||||
// Output is pictures, meshes, video, audio or files.
|
||||
Output string `json:"output"`
|
||||
Inputs []WorkflowInput `json:"inputs"`
|
||||
}
|
||||
|
||||
// WorkflowInput is one input a workflow takes.
|
||||
type WorkflowInput struct {
|
||||
Name string `json:"name"`
|
||||
// Type is text, int, float, bool, choice, image, mask, audio, video or
|
||||
// file; the last five are sent as base64, a data URL, or a file's id.
|
||||
Type string `json:"type"`
|
||||
Required bool `json:"required,omitempty"`
|
||||
Default any `json:"default,omitempty"`
|
||||
Min *float64 `json:"min,omitempty"`
|
||||
Max *float64 `json:"max,omitempty"`
|
||||
Choices []string `json:"choices,omitempty"`
|
||||
MaxMB int `json:"max_mb,omitempty"`
|
||||
Doc string `json:"doc,omitempty"`
|
||||
}
|
||||
|
||||
// RunRequest asks a ComfyUI model to run its workflow.
|
||||
type RunRequest struct {
|
||||
Model string `json:"model"`
|
||||
// Inputs are by name, as the model's workflow lists them in /v1/models.
|
||||
Inputs map[string]any `json:"inputs"`
|
||||
// Seed is the workflow's {{seed}}, where it has one; random otherwise.
|
||||
Seed *int64 `json:"seed,omitempty"`
|
||||
}
|
||||
|
||||
// ModelInfo is a model a key may use.
|
||||
type ModelInfo struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Created int64 `json:"created"`
|
||||
OwnedBy string `json:"owned_by"`
|
||||
// Loaded is whether a replica is up now; a model that loads when asked
|
||||
// is listed asleep too, and its first request waits for it to load.
|
||||
Loaded bool `json:"loaded"`
|
||||
// ContextLength and MaxOutputTokens, where the catalog says.
|
||||
ContextLength int `json:"context_length,omitempty"`
|
||||
MaxOutputTokens int `json:"max_output_tokens,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
// Capabilities: tools, vision, embeddings, images, meshes, workflows.
|
||||
Capabilities map[string]bool `json:"capabilities"`
|
||||
License *License `json:"license,omitempty"`
|
||||
// Workflow is what a ComfyUI model takes and makes.
|
||||
Workflow *WorkflowInfo `json:"workflow,omitempty"`
|
||||
}
|
||||
|
||||
// ModelList is the models a key may use.
|
||||
type ModelList struct {
|
||||
Object string `json:"object"`
|
||||
Data []ModelInfo `json:"data"`
|
||||
}
|
||||
|
||||
// FileForm is a file uploaded, as a form.
|
||||
type FileForm struct {
|
||||
File []byte `json:"file"`
|
||||
// Purpose is batch for a batch's input.
|
||||
Purpose string `json:"purpose"`
|
||||
}
|
||||
|
||||
// File is a file kept: a batch's input or output, a job's result.
|
||||
type File struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Bytes int64 `json:"bytes"`
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
Filename string `json:"filename"`
|
||||
// Purpose is batch, batch_output or job_output.
|
||||
Purpose string `json:"purpose"`
|
||||
Status string `json:"status"`
|
||||
ExpiresAt int64 `json:"expires_at,omitempty"`
|
||||
}
|
||||
|
||||
// FileList is the caller's files.
|
||||
type FileList struct {
|
||||
Object string `json:"object"`
|
||||
Data []File `json:"data"`
|
||||
}
|
||||
|
||||
// Deleted says a thing is gone.
|
||||
type Deleted struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Deleted bool `json:"deleted"`
|
||||
}
|
||||
|
||||
// BatchRequest runs a file of requests, at the lowest priority.
|
||||
type BatchRequest struct {
|
||||
InputFileID string `json:"input_file_id"`
|
||||
// Endpoint is /v1/chat/completions, /v1/completions or /v1/embeddings.
|
||||
Endpoint string `json:"endpoint"`
|
||||
// CompletionWindow is 24h.
|
||||
CompletionWindow string `json:"completion_window"`
|
||||
Metadata map[string]string `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
// RequestCounts is how a batch's lines went.
|
||||
type RequestCounts struct {
|
||||
Total int `json:"total"`
|
||||
Completed int `json:"completed"`
|
||||
Failed int `json:"failed"`
|
||||
}
|
||||
|
||||
// Batch is a batch and how far it is.
|
||||
type Batch struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Endpoint string `json:"endpoint"`
|
||||
InputFileID string `json:"input_file_id"`
|
||||
CompletionWindow string `json:"completion_window"`
|
||||
Status string `json:"status"`
|
||||
OutputFileID *string `json:"output_file_id"`
|
||||
ErrorFileID *string `json:"error_file_id"`
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
InProgressAt *int64 `json:"in_progress_at"`
|
||||
ExpiresAt *int64 `json:"expires_at"`
|
||||
FinalizingAt *int64 `json:"finalizing_at"`
|
||||
CompletedAt *int64 `json:"completed_at"`
|
||||
FailedAt *int64 `json:"failed_at"`
|
||||
ExpiredAt *int64 `json:"expired_at"`
|
||||
CancellingAt *int64 `json:"cancelling_at"`
|
||||
CancelledAt *int64 `json:"cancelled_at"`
|
||||
RequestCounts RequestCounts `json:"request_counts"`
|
||||
Errors json.RawMessage `json:"errors"`
|
||||
Metadata json.RawMessage `json:"metadata"`
|
||||
}
|
||||
|
||||
// BatchList is the caller's batches.
|
||||
type BatchList struct {
|
||||
Object string `json:"object"`
|
||||
Data []Batch `json:"data"`
|
||||
HasMore bool `json:"has_more"`
|
||||
}
|
||||
|
||||
// MeshRequest asks for a 3D model from a picture, of a model that makes
|
||||
// them: a job.
|
||||
type MeshRequest struct {
|
||||
Model string `json:"model"`
|
||||
// Image is the picture, base64 or a data URL: PNG, JPEG or WebP, one
|
||||
// object on a plain background.
|
||||
Image string `json:"image"`
|
||||
Seed *int64 `json:"seed,omitempty"`
|
||||
Steps int `json:"steps,omitempty"`
|
||||
// Resolution is the model's grid, a multiple of 32 from 64 to 2048.
|
||||
Resolution int `json:"resolution,omitempty"`
|
||||
}
|
||||
|
||||
// JobProgress is how far along a job is.
|
||||
type JobProgress struct {
|
||||
// State is queued, running, done or failed.
|
||||
State string `json:"state"`
|
||||
// Ahead is how many wait before it, while queued.
|
||||
Ahead int `json:"ahead,omitempty"`
|
||||
NodeClass string `json:"node_class,omitempty"`
|
||||
Step int `json:"step,omitempty"`
|
||||
Steps int `json:"steps,omitempty"`
|
||||
Percent int `json:"percent,omitempty"`
|
||||
}
|
||||
|
||||
// JobUsage is what a finished job used.
|
||||
type JobUsage struct {
|
||||
PromptTokens int64 `json:"prompt_tokens"`
|
||||
CompletionTokens int64 `json:"completion_tokens"`
|
||||
Images int64 `json:"images"`
|
||||
Meshes int64 `json:"meshes"`
|
||||
}
|
||||
|
||||
// Job is a 3D model asked for: its status, progress and, when done, the
|
||||
// file its result is in.
|
||||
type Job struct {
|
||||
ID string `json:"id"`
|
||||
Object string `json:"object"`
|
||||
Endpoint string `json:"endpoint"`
|
||||
Model string `json:"model"`
|
||||
// Status is queued, running, cancelling, completed, failed, cancelled
|
||||
// or expired.
|
||||
Status string `json:"status"`
|
||||
Progress *JobProgress `json:"progress"`
|
||||
OutputFileID *string `json:"output_file_id"`
|
||||
ContentType *string `json:"content_type"`
|
||||
Error *ErrorBody `json:"error"`
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
StartedAt *int64 `json:"started_at"`
|
||||
FinishedAt *int64 `json:"finished_at"`
|
||||
ExpiresAt *int64 `json:"expires_at"`
|
||||
Usage *JobUsage `json:"usage"`
|
||||
License *License `json:"license,omitempty"`
|
||||
}
|
||||
|
||||
// JobList is the caller's jobs.
|
||||
type JobList struct {
|
||||
Object string `json:"object"`
|
||||
Data []Job `json:"data"`
|
||||
HasMore bool `json:"has_more"`
|
||||
FirstID *string `json:"first_id"`
|
||||
LastID *string `json:"last_id"`
|
||||
}
|
||||
|
||||
// MemoryWrite is a note kept for the caller's project.
|
||||
type MemoryWrite struct {
|
||||
Text string `json:"text"`
|
||||
Tags []string `json:"tags,omitempty"`
|
||||
}
|
||||
|
||||
// MemoryNote is a note kept.
|
||||
type MemoryNote struct {
|
||||
Key string `json:"key"`
|
||||
Text string `json:"text"`
|
||||
Tags []string `json:"tags"`
|
||||
CreatedAt string `json:"created_at"`
|
||||
UpdatedAt string `json:"updated_at"`
|
||||
}
|
||||
|
||||
// MemoryList is the project's notes.
|
||||
type MemoryList struct {
|
||||
Object string `json:"object"`
|
||||
Data []MemoryNote `json:"data"`
|
||||
}
|
||||
|
||||
// Me is the caller as the gateway sees it: its key, place and limits.
|
||||
type Me struct {
|
||||
Authenticated bool `json:"authenticated"`
|
||||
KeyID string `json:"key_id,omitempty"`
|
||||
Key string `json:"key,omitempty"`
|
||||
Project string `json:"project,omitempty"`
|
||||
Team string `json:"team,omitempty"`
|
||||
Organization string `json:"organization,omitempty"`
|
||||
// Limits and Usage are what applies and what has been used of it.
|
||||
Limits json.RawMessage `json:"limits,omitempty"`
|
||||
Usage json.RawMessage `json:"usage,omitempty"`
|
||||
}
|
||||
|
||||
// MCPRequest is a JSON-RPC 2.0 call to the gateway's MCP server: its tools
|
||||
// are the memory notes.
|
||||
type MCPRequest struct {
|
||||
JSONRPC string `json:"jsonrpc"`
|
||||
ID json.RawMessage `json:"id"`
|
||||
Method string `json:"method"`
|
||||
Params json.RawMessage `json:"params,omitempty"`
|
||||
}
|
||||
|
||||
// KBDeleted says a document left a collection.
|
||||
type KBDeleted struct {
|
||||
Name string `json:"name"`
|
||||
Deleted bool `json:"deleted"`
|
||||
}
|
||||
@@ -0,0 +1,123 @@
|
||||
package clientapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/router"
|
||||
)
|
||||
|
||||
type (
|
||||
// Route and Param are the admin API's, which one generator reads.
|
||||
Route = adminapi.Route
|
||||
Param = adminapi.Param
|
||||
)
|
||||
|
||||
// PathParams describes the parameters in Routes' paths.
|
||||
var PathParams = map[string]string{
|
||||
"files/{id}": "The file's ID, file-….",
|
||||
"batches/{id}": "The batch's ID, batch_….",
|
||||
"generations/{id}": "The job's ID, job_….",
|
||||
"runs/{id}": "The job's ID, job_….",
|
||||
"threads/{id}": "The conversation's ID, as sent in x-llmgw-thread.",
|
||||
"memory/{key}": "The note's key, chosen by the caller.",
|
||||
"collections/{id}": "The collection's ID, its name when that is unique, or ORG/NAME.",
|
||||
}
|
||||
|
||||
// any is a body whose shape is the engine's or the provider's own.
|
||||
var anyJSON = json.RawMessage{}
|
||||
|
||||
// Routes is every endpoint the client API serves, but /health, /ready and
|
||||
// /leader, which are a load balancer's and need no key.
|
||||
var Routes = []Route{
|
||||
{Method: "POST", Path: "/v1/chat/completions", Summary: "A chat turn",
|
||||
Description: "A model's name, an alias, or an adapter's name. Fields not listed go to the engine as sent. " +
|
||||
"With a knowledge base, x-llmgw-knowledge names the collections to answer from; x-llmgw-thread continues a stored conversation.",
|
||||
Request: ChatCompletionRequest{}, Response: ChatCompletion{}, Stream: true},
|
||||
{Method: "POST", Path: "/v1/completions", Summary: "A prompt continued",
|
||||
Request: CompletionRequest{}, Response: Completion{}, Stream: true},
|
||||
{Method: "POST", Path: "/v1/embeddings", Summary: "Vectors for texts",
|
||||
Request: EmbeddingRequest{}, Response: EmbeddingList{}},
|
||||
{Method: "POST", Path: "/v1/rerank", Summary: "Documents ordered by a query, for a reranker vLLM serves",
|
||||
Request: RerankRequest{}, Response: anyJSON},
|
||||
{Method: "POST", Path: "/v1/score", Summary: "Pairs of texts scored, for a scorer vLLM serves",
|
||||
Request: ScoreRequest{}, Response: anyJSON},
|
||||
{Method: "POST", Path: "/v1/audio/transcriptions", Summary: "Speech to text",
|
||||
Request: TranscriptionForm{}, Form: true, Response: Transcription{}},
|
||||
{Method: "POST", Path: "/v1/audio/translations", Summary: "Speech to English text",
|
||||
Request: TranscriptionForm{}, Form: true, Response: Transcription{}},
|
||||
{Method: "POST", Path: "/v1/images/generations", Summary: "Pictures, of a model that makes them",
|
||||
Description: "Made by ComfyUI. Pictures come back as b64_json and are kept nowhere; x-llmgw-seed says the seed.",
|
||||
Request: ImageRequest{}, Response: ImagesResponse{}},
|
||||
{Method: "POST", Path: "/v1/3d/generations", Summary: "A 3D model from a picture, as a job",
|
||||
Description: "Answered 202 with the job; ask after it until it is completed, then download output_file_id from /v1/files.",
|
||||
Request: MeshRequest{}, Response: Job{}, Status: 202},
|
||||
{Method: "GET", Path: "/v1/3d/generations", Summary: "The caller's 3D jobs, newest first",
|
||||
Query: []Param{
|
||||
{Name: "limit", Type: "integer", Description: "The most jobs to answer with, at most 100; 20 when absent."},
|
||||
{Name: "after", Description: "A job's ID: those asked for before it."},
|
||||
},
|
||||
Response: JobList{}},
|
||||
{Method: "GET", Path: "/v1/3d/generations/{id}", Summary: "A 3D job: its status, progress and result", Response: Job{}},
|
||||
{Method: "POST", Path: "/v1/3d/generations/{id}/cancel", Summary: "Stop a 3D job, in the engine's queue too", Response: Job{}},
|
||||
{Method: "POST", Path: "/v1/workflows/runs", Summary: "Run a ComfyUI model's workflow, as a job",
|
||||
Description: "Inputs are those the model's workflow lists in /v1/models. Answered 202 with the job; " +
|
||||
"download output_file_id from /v1/files once it is completed.",
|
||||
Request: RunRequest{}, Response: Job{}, Status: 202},
|
||||
{Method: "GET", Path: "/v1/workflows/runs", Summary: "The caller's jobs, newest first",
|
||||
Query: []Param{
|
||||
{Name: "limit", Type: "integer", Description: "The most jobs to answer with, at most 100; 20 when absent."},
|
||||
{Name: "after", Description: "A job's ID: those asked for before it."},
|
||||
},
|
||||
Response: JobList{}},
|
||||
{Method: "GET", Path: "/v1/workflows/runs/{id}", Summary: "A run: its status, progress and result", Response: Job{}},
|
||||
{Method: "POST", Path: "/v1/workflows/runs/{id}/cancel", Summary: "Stop a run, in the engine's queue too", Response: Job{}},
|
||||
{Method: "POST", Path: "/v1/moderations", Summary: "Texts judged by the guardrails' judge model",
|
||||
Request: ModerationRequest{}, Response: ModerationResponse{}},
|
||||
{Method: "POST", Path: "/v1/responses", Summary: "OpenAI's Responses API, for Codex and the like",
|
||||
Request: ResponsesRequest{}, Response: anyJSON, Stream: true},
|
||||
{Method: "POST", Path: "/v1/messages", Summary: "Anthropic's Messages API, for Claude Code and Anthropic's SDKs",
|
||||
Description: "The key is sent as x-api-key or as a bearer token.",
|
||||
Request: MessagesRequest{}, Response: anyJSON, Stream: true},
|
||||
{Method: "POST", Path: "/v1/messages/count_tokens", Summary: "How many tokens a Messages request would be",
|
||||
Request: MessagesRequest{}, Response: TokenCount{}},
|
||||
{Method: "GET", Path: "/v1/models", Summary: "The models the key may use", Response: ModelList{}},
|
||||
{Method: "POST", Path: "/v1/files", Summary: "Upload a file: a batch's input",
|
||||
Request: FileForm{}, Form: true, Response: File{}},
|
||||
{Method: "GET", Path: "/v1/files", Summary: "The caller's files",
|
||||
Query: []Param{{Name: "purpose", Description: "Only files of this purpose: batch, batch_output, job_output."}},
|
||||
Response: FileList{}},
|
||||
{Method: "GET", Path: "/v1/files/{id}", Summary: "A file", Response: File{}},
|
||||
{Method: "GET", Path: "/v1/files/{id}/content", Summary: "A file's content",
|
||||
Binary: "application/octet-stream"},
|
||||
{Method: "DELETE", Path: "/v1/files/{id}", Summary: "Delete a file", Response: Deleted{}},
|
||||
{Method: "POST", Path: "/v1/batches", Summary: "Run a file of requests at the lowest priority",
|
||||
Request: BatchRequest{}, Response: Batch{}},
|
||||
{Method: "GET", Path: "/v1/batches", Summary: "The caller's batches",
|
||||
Query: []Param{
|
||||
{Name: "limit", Type: "integer", Description: "The most batches to answer with; 20 when absent."},
|
||||
{Name: "after", Description: "A batch's ID: those made before it."},
|
||||
},
|
||||
Response: BatchList{}},
|
||||
{Method: "GET", Path: "/v1/batches/{id}", Summary: "A batch and how far it is", Response: Batch{}},
|
||||
{Method: "POST", Path: "/v1/batches/{id}/cancel", Summary: "Stop a batch", Response: Batch{}},
|
||||
{Method: "DELETE", Path: "/v1/threads/{id}", Summary: "Forget a stored conversation"},
|
||||
{Method: "PUT", Path: "/v1/memory/{key}", Summary: "Keep a note for the project",
|
||||
Request: MemoryWrite{}, Response: MemoryNote{}},
|
||||
{Method: "GET", Path: "/v1/memory/{key}", Summary: "A note", Response: MemoryNote{}},
|
||||
{Method: "GET", Path: "/v1/memory", Summary: "The project's notes", Response: MemoryList{}},
|
||||
{Method: "DELETE", Path: "/v1/memory/{key}", Summary: "Forget a note"},
|
||||
{Method: "POST", Path: "/mcp", Summary: "The gateway's MCP server: the memory notes, and pictures, 3D models, vision and workflows, as tools",
|
||||
Request: MCPRequest{}, Response: anyJSON},
|
||||
{Method: "GET", Path: "/me", Summary: "The caller: its key, its place in the tree, its limits and what it has used",
|
||||
Response: Me{}},
|
||||
{Method: "GET", Path: "/v1/kb/collections", Summary: "The knowledge-base collections the caller may read",
|
||||
Response: []router.KBCollectionView{}},
|
||||
{Method: "GET", Path: "/v1/kb/collections/{id}/manifest", Summary: "A collection and its documents",
|
||||
Response: router.KBManifest{}},
|
||||
{Method: "PUT", Path: "/v1/kb/collections/{id}/documents", Summary: "Add or replace a document, read and embedded by the client",
|
||||
Request: router.KBPutDocument{}, Response: router.KBPutResult{}},
|
||||
{Method: "DELETE", Path: "/v1/kb/collections/{id}/documents", Summary: "Take a document out of a collection",
|
||||
Query: []Param{{Name: "name", Required: true, Description: "The document's name, as the manifest lists it."}},
|
||||
Response: KBDeleted{}},
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
package clientapi
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"runtime"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// routerRoutes are the client API's routes as the router mounts them, read
|
||||
// from its source: every mux.HandleFunc under /v1, /mcp and /me, with the
|
||||
// path constants it builds some of them from put back.
|
||||
func routerRoutes(t *testing.T) []string {
|
||||
t.Helper()
|
||||
_, file, _, _ := runtime.Caller(0)
|
||||
dir := filepath.Join(filepath.Dir(file), "..", "router")
|
||||
consts := map[string]string{"imagesPath": "/v1/images/generations", "meshesPath": "/v1/3d/generations",
|
||||
"workflowsPath": "/v1/workflows/runs"}
|
||||
literal := regexp.MustCompile(`mux\.HandleFunc\("([A-Z]+) (/[^"]*)"`)
|
||||
built := regexp.MustCompile(`mux\.HandleFunc\("([A-Z]+) "\+([A-Za-z]+Path)(\+"([^"]*)")?`)
|
||||
files, _ := filepath.Glob(filepath.Join(dir, "*.go"))
|
||||
var out []string
|
||||
add := func(method, path string) {
|
||||
if strings.HasPrefix(path, "/v1/") || path == "/mcp" || path == "/me" {
|
||||
out = append(out, method+" "+path)
|
||||
}
|
||||
}
|
||||
for _, f := range files {
|
||||
if strings.HasSuffix(f, "_test.go") {
|
||||
continue
|
||||
}
|
||||
b, _ := os.ReadFile(f)
|
||||
for _, m := range literal.FindAllStringSubmatch(string(b), -1) {
|
||||
add(m[1], m[2])
|
||||
}
|
||||
for _, m := range built.FindAllStringSubmatch(string(b), -1) {
|
||||
c, ok := consts[m[2]]
|
||||
if !ok {
|
||||
t.Fatalf("a route built from %s, which this test does not know", m[2])
|
||||
}
|
||||
add(m[1], c+m[4])
|
||||
}
|
||||
}
|
||||
slices.Sort(out)
|
||||
return slices.Compact(out)
|
||||
}
|
||||
|
||||
func TestEveryClientRouteIsDescribedAndNothingElse(t *testing.T) {
|
||||
// An endpoint added to the router and not to this table would be missing
|
||||
// from the document every SDK is generated from; one here and not in the
|
||||
// router would be a path that answers 404.
|
||||
mounted := routerRoutes(t)
|
||||
if len(mounted) < 30 {
|
||||
t.Fatalf("read only %d routes from the router: %v", len(mounted), mounted)
|
||||
}
|
||||
var described []string
|
||||
for _, r := range Routes {
|
||||
described = append(described, r.Method+" "+r.Path)
|
||||
}
|
||||
slices.Sort(described)
|
||||
for _, m := range mounted {
|
||||
if m == "GET /v1/openapi.json" {
|
||||
continue // the document itself
|
||||
}
|
||||
if !slices.Contains(described, m) {
|
||||
t.Errorf("%s is mounted and not described in clientapi.Routes", m)
|
||||
}
|
||||
}
|
||||
for _, d := range described {
|
||||
if !slices.Contains(mounted, d) {
|
||||
t.Errorf("%s is described and not mounted", d)
|
||||
}
|
||||
}
|
||||
}
|
||||
+87
-15
@@ -108,6 +108,11 @@ type Params struct {
|
||||
}
|
||||
|
||||
func (p Params) value(name string) (any, bool) {
|
||||
// A workflow's own input of a built-in's name is the request's: an input
|
||||
// named prompt is the prompt a run was given.
|
||||
if v, ok := p.Extra[name]; ok {
|
||||
return v, true
|
||||
}
|
||||
switch name {
|
||||
case "checkpoint":
|
||||
return p.Checkpoint, p.Checkpoint != ""
|
||||
@@ -130,8 +135,44 @@ func (p Params) value(name string) (any, bool) {
|
||||
case "image":
|
||||
return p.Image, p.Image != ""
|
||||
}
|
||||
v, ok := p.Extra[name]
|
||||
return v, ok
|
||||
return nil, false
|
||||
}
|
||||
|
||||
// Builtin are the placeholders Params fills by itself, which a workflow may
|
||||
// use without declaring them as inputs.
|
||||
var Builtin = []string{"checkpoint", "prompt", "negative_prompt", "width", "height", "n", "seed", "steps", "guidance", "image"}
|
||||
|
||||
// Placeholders are the names a template's placeholders use, each once,
|
||||
// sorted, and whether each has a default of its own.
|
||||
func (t *Template) Placeholders() map[string]bool {
|
||||
out := map[string]bool{}
|
||||
var walk func(v any)
|
||||
walk = func(v any) {
|
||||
switch v := v.(type) {
|
||||
case map[string]any:
|
||||
for _, x := range v {
|
||||
walk(x)
|
||||
}
|
||||
case []any:
|
||||
for _, x := range v {
|
||||
walk(x)
|
||||
}
|
||||
case string:
|
||||
for s := v; ; {
|
||||
i := strings.Index(s, "{{")
|
||||
j := strings.Index(s, "}}")
|
||||
if i < 0 || j < i {
|
||||
return
|
||||
}
|
||||
name, _, hasDef := strings.Cut(s[i+2:j], "|")
|
||||
name = strings.TrimSpace(name)
|
||||
out[name] = out[name] || hasDef
|
||||
s = s[j+2:]
|
||||
}
|
||||
}
|
||||
}
|
||||
walk(t.graph)
|
||||
return out
|
||||
}
|
||||
|
||||
// Fill is the workflow for one request.
|
||||
@@ -181,6 +222,10 @@ func fillString(s string, p Params, missing *[]string) any {
|
||||
if f, err := strconv.ParseFloat(def, 64); err == nil {
|
||||
return f, true
|
||||
}
|
||||
// A BOOLEAN input refuses the word: {{albedo_match|false}}.
|
||||
if b, err := strconv.ParseBool(def); err == nil && (def == "true" || def == "false") {
|
||||
return b, true
|
||||
}
|
||||
return def, true
|
||||
}
|
||||
*missing = append(*missing, name)
|
||||
@@ -398,9 +443,17 @@ func (c *Client) fetch(ctx context.Context, base, apiKey string, h historyEntry)
|
||||
return nil, err
|
||||
}
|
||||
img.Name = f.Filename
|
||||
if t := typeByName(f.Filename); t != "" && (img.ContentType == "" ||
|
||||
strings.HasPrefix(img.ContentType, "application/octet-stream") || strings.HasPrefix(img.ContentType, "text/plain")) {
|
||||
img.ContentType = t
|
||||
// A type the server did not say is the file's by its name,
|
||||
// else by its first bytes.
|
||||
if generic(img.ContentType) {
|
||||
if t := typeByName(f.Filename); t != "" {
|
||||
img.ContentType = t
|
||||
} else {
|
||||
img.ContentType = http.DetectContentType(img.Data)
|
||||
}
|
||||
}
|
||||
if img.ContentType == "image/png" {
|
||||
img.Data = withoutPNGText(img.Data)
|
||||
}
|
||||
out = append(out, img)
|
||||
}
|
||||
@@ -497,14 +550,12 @@ func (c *Client) get(ctx context.Context, u, apiKey string) (Image, error) {
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return Image{}, &Error{Msg: fmt.Sprintf("ComfyUI answered %d for a file it made", resp.StatusCode)}
|
||||
}
|
||||
ct := resp.Header.Get("Content-Type")
|
||||
if ct == "" || ct == "application/octet-stream" {
|
||||
ct = http.DetectContentType(b)
|
||||
}
|
||||
if ct == "image/png" {
|
||||
b = withoutPNGText(b)
|
||||
}
|
||||
return Image{Data: b, ContentType: ct}, nil
|
||||
return Image{Data: b, ContentType: resp.Header.Get("Content-Type")}, nil
|
||||
}
|
||||
|
||||
// generic is a type that says nothing of what a file is.
|
||||
func generic(ct string) bool {
|
||||
return ct == "" || strings.HasPrefix(ct, "application/octet-stream") || strings.HasPrefix(ct, "text/plain")
|
||||
}
|
||||
|
||||
// withoutPNGText is a PNG without its text chunks. ComfyUI writes the whole
|
||||
@@ -604,12 +655,33 @@ func typeByName(name string) string {
|
||||
return "application/ply"
|
||||
case ".png":
|
||||
return "image/png"
|
||||
case ".jpg", ".jpeg":
|
||||
return "image/jpeg"
|
||||
case ".webp":
|
||||
return "image/webp"
|
||||
case ".gif":
|
||||
return "image/gif"
|
||||
case ".mp4":
|
||||
return "video/mp4"
|
||||
case ".webm":
|
||||
return "video/webm"
|
||||
case ".mov":
|
||||
return "video/quicktime"
|
||||
case ".wav":
|
||||
return "audio/wav"
|
||||
case ".mp3":
|
||||
return "audio/mpeg"
|
||||
case ".flac":
|
||||
return "audio/flac"
|
||||
case ".ogg", ".opus":
|
||||
return "audio/ogg"
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// Upload puts a picture in ComfyUI's input directory, where a LoadImage node
|
||||
// reads it, and returns the name it was given there.
|
||||
// Upload puts a file in ComfyUI's input directory, where a loader node reads
|
||||
// it — LoadImage, LoadAudio, LoadVideo, whatever the workflow uses: ComfyUI's
|
||||
// /upload/image takes any file — and returns the name it was given there.
|
||||
func (c *Client) Upload(ctx context.Context, base, apiKey, name string, data []byte) (string, error) {
|
||||
base = strings.TrimRight(base, "/")
|
||||
var body bytes.Buffer
|
||||
|
||||
@@ -15,6 +15,9 @@ import (
|
||||
|
||||
func TestTheBuiltInWorkflowsFillIn(t *testing.T) {
|
||||
for _, name := range Builtins() {
|
||||
if raw, _ := builtin.ReadFile("workflows/" + name + ".json"); strings.Contains(string(raw), "{{image}}") {
|
||||
continue // made from a picture: TestTheBuiltInMeshWorkflowFillsIn
|
||||
}
|
||||
tpl, err := Load(name)
|
||||
if err != nil {
|
||||
t.Fatalf("%s: %v", name, err)
|
||||
@@ -37,6 +40,30 @@ func TestTheBuiltInWorkflowsFillIn(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheBuiltInMeshWorkflowFillsIn(t *testing.T) {
|
||||
tpl, err := Load("triposr")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
g, err := tpl.Fill(Params{Checkpoint: "model.ckpt", Image: "llmgw-1.png"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
b, _ := json.Marshal(g)
|
||||
s := string(b)
|
||||
// The picture is cut out and centred before TripoSR sees it: without
|
||||
// that, its background becomes geometry.
|
||||
for _, want := range []string{`"image":"llmgw-1.png"`, `"model":"model.ckpt"`, `"geometry_resolution":256`,
|
||||
`"class_type":"LLMGWPrepareForMesh"`, `"reference_image":["5",0]`} {
|
||||
if !strings.Contains(s, want) {
|
||||
t.Errorf("%s not in %s", want, s)
|
||||
}
|
||||
}
|
||||
if strings.Contains(s, "{{") {
|
||||
t.Errorf("a placeholder was left: %s", s)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAStepCountGivenReplacesTheDefault(t *testing.T) {
|
||||
tpl, _ := Load("flux-schnell")
|
||||
g, _ := tpl.Fill(Params{Checkpoint: "c", Prompt: "p", Width: 512, Height: 512})
|
||||
@@ -225,3 +252,19 @@ func TestAPictureLosesTheWorkflowComfyUIWroteIntoIt(t *testing.T) {
|
||||
t.Error("a truncated PNG was changed")
|
||||
}
|
||||
}
|
||||
|
||||
func TestATrueOrFalseDefaultIsABoolean(t *testing.T) {
|
||||
// A BOOLEAN input refuses the word "false": sf3d's albedo_match.
|
||||
tpl, err := Load((`{"5":{"class_type":"LLMGWSaveMesh","inputs":{"albedo_match":"{{albedo_match|false}}","count":"{{count|2}}","s":"{{s|x}}"}}}`))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
g, err := tpl.Fill(Params{})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
in := g["5"].(map[string]any)["inputs"].(map[string]any)
|
||||
if in["albedo_match"] != false || in["count"] != 2.0 || in["s"] != "x" {
|
||||
t.Errorf("inputs %#v", in)
|
||||
}
|
||||
}
|
||||
+209
-5
@@ -3,6 +3,7 @@ package comfy
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"crypto/sha1"
|
||||
"crypto/subtle"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
@@ -19,6 +20,7 @@ import (
|
||||
"os/signal"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
"syscall"
|
||||
@@ -99,6 +101,9 @@ func RunGate(ctx context.Context, cfg GateConfig) error {
|
||||
if out == nil {
|
||||
out = os.Stdout
|
||||
}
|
||||
if err := installOwnNodes(state); err != nil {
|
||||
return fmt.Errorf("llmgw's own ComfyUI nodes: %w", err)
|
||||
}
|
||||
nodes, err := parseNodes(os.Getenv(NodesEnv))
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -108,9 +113,36 @@ func RunGate(ctx context.Context, cfg GateConfig) error {
|
||||
return err
|
||||
}
|
||||
models := filepath.Join(state, "models")
|
||||
if err := LinkWeights(cfg.Weights, models); err != nil {
|
||||
shared, err := parseShared(os.Getenv(SharedModelsEnv))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
all := []string{cfg.Weights}
|
||||
for _, m := range shared {
|
||||
all = append(all, m.Path)
|
||||
}
|
||||
if err := LinkAllWeights(all, models); err != nil {
|
||||
return err
|
||||
}
|
||||
if repo := os.Getenv(HFRepoEnv); repo != "" {
|
||||
if err := LinkHFCache(cfg.Weights, repo, hfHubDir()); err != nil {
|
||||
return fmt.Errorf("showing the weights as %s: %w", repo, err)
|
||||
}
|
||||
}
|
||||
for _, m := range shared {
|
||||
if m.HFRepo == "" {
|
||||
continue
|
||||
}
|
||||
if err := LinkHFCache(m.Path, m.HFRepo, hfHubDir()); err != nil {
|
||||
return fmt.Errorf("showing %s's weights as %s: %w", m.Name, m.HFRepo, err)
|
||||
}
|
||||
}
|
||||
names := []string{cfg.Model}
|
||||
for _, m := range shared {
|
||||
if !slices.Contains(names, m.Name) {
|
||||
names = append(names, m.Name)
|
||||
}
|
||||
}
|
||||
extra := filepath.Join(state, "extra_model_paths.yaml")
|
||||
if err := os.WriteFile(extra, []byte(extraModelPaths(models)), 0o644); err != nil { //nolint:gosec // not secret
|
||||
return err
|
||||
@@ -168,7 +200,7 @@ func RunGate(ctx context.Context, cfg GateConfig) error {
|
||||
go book.watch(ctx, upstream, clientID, log)
|
||||
srv := &http.Server{
|
||||
Addr: cfg.Listen,
|
||||
Handler: newGate(upstream, cfg.Key, cfg.Model, book, clientID),
|
||||
Handler: newGate(upstream, cfg.Key, names, book, clientID),
|
||||
ReadHeaderTimeout: 10 * time.Second,
|
||||
}
|
||||
served := make(chan error, 1)
|
||||
@@ -209,12 +241,12 @@ func shutdown(srv *http.Server) {
|
||||
|
||||
// NewGate is the gate's handler, in front of the ComfyUI at upstream.
|
||||
func NewGate(upstream *url.URL, key, model string) http.Handler {
|
||||
return newGate(upstream, key, model, newProgressBook(), "")
|
||||
return newGate(upstream, key, []string{model}, newProgressBook(), "")
|
||||
}
|
||||
|
||||
// newGate is the gate with the book of its workflows' progress, kept under
|
||||
// clientID; an empty one leaves the workflows' own client ids alone.
|
||||
func newGate(upstream *url.URL, key, model string, book *progressBook, clientID string) http.Handler {
|
||||
func newGate(upstream *url.URL, key string, names []string, book *progressBook, clientID string) http.Handler {
|
||||
proxy := httputil.NewSingleHostReverseProxy(upstream)
|
||||
base := proxy.Director
|
||||
proxy.Director = func(r *http.Request) {
|
||||
@@ -260,7 +292,11 @@ func newGate(upstream *url.URL, key, model string, book *progressBook, clientID
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
fmt.Fprintf(w, `{"object":"list","data":[{"id":%q,"object":"model","owned_by":"comfyui"}]}`, model)
|
||||
data := make([]map[string]string, 0, len(names))
|
||||
for _, n := range names {
|
||||
data = append(data, map[string]string{"id": n, "object": "model", "owned_by": "comfyui"})
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"object": "list", "data": data})
|
||||
return
|
||||
}
|
||||
if id, ok := strings.CutPrefix(r.URL.Path, "/progress/"); ok && r.Method == http.MethodGet {
|
||||
@@ -297,6 +333,106 @@ func FileName(path string) string {
|
||||
return cachedName.ReplaceAllString(filepath.Base(path), "")
|
||||
}
|
||||
|
||||
// SharedModelsEnv is where the agent hands a shared replica's gate its
|
||||
// members: name, the path their weights were fetched to, and the repository
|
||||
// a node loads them by name from.
|
||||
const SharedModelsEnv = "LLMGW_COMFYUI_MODELS"
|
||||
|
||||
// sharedModel is one member of a shared replica.
|
||||
type sharedModel struct {
|
||||
Name string `json:"name"`
|
||||
Path string `json:"path"`
|
||||
HFRepo string `json:"hf_repo"`
|
||||
}
|
||||
|
||||
func parseShared(raw string) ([]sharedModel, error) {
|
||||
if strings.TrimSpace(raw) == "" {
|
||||
return nil, nil
|
||||
}
|
||||
var ms []sharedModel
|
||||
if err := json.Unmarshal([]byte(raw), &ms); err != nil {
|
||||
return nil, fmt.Errorf("%s: %w", SharedModelsEnv, err)
|
||||
}
|
||||
for _, m := range ms {
|
||||
if m.Name == "" || m.Path == "" {
|
||||
return nil, fmt.Errorf("%s: a member with no name or no fetched path", SharedModelsEnv)
|
||||
}
|
||||
}
|
||||
return ms, nil
|
||||
}
|
||||
|
||||
// LinkAllWeights shows ComfyUI every model's weights at once, for a replica
|
||||
// that answers for several: links made before are taken away first, then
|
||||
// each file of each is linked by its name. Two weights files of one name
|
||||
// are refused — ComfyUI would load one for both; anything else of one name
|
||||
// (a README, a licence) the first keeps.
|
||||
func LinkAllWeights(weights []string, dir string) error {
|
||||
if len(weights) == 1 {
|
||||
return LinkWeights(weights[0], dir)
|
||||
}
|
||||
if err := LinkWeights(weights[0], dir); err != nil {
|
||||
return err
|
||||
}
|
||||
for _, w := range weights[1:] {
|
||||
files, err := weightFiles(w)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
for _, f := range files {
|
||||
link := filepath.Join(dir, FileName(f))
|
||||
if cur, err := os.Readlink(link); err == nil {
|
||||
if cur == f {
|
||||
continue
|
||||
}
|
||||
if isWeightsFile(f) {
|
||||
return fmt.Errorf("two models' weights are both named %s (%s and %s): give one comfyui.checkpoint of another name",
|
||||
FileName(f), cur, f)
|
||||
}
|
||||
continue
|
||||
}
|
||||
if err := os.Symlink(f, link); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// weightFiles are the files a weights source is: itself, or each of its
|
||||
// directory's.
|
||||
func weightFiles(weights string) ([]string, error) {
|
||||
weights, err := filepath.Abs(weights)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
info, err := os.Stat(weights)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("the weights: %w", err)
|
||||
}
|
||||
if !info.IsDir() {
|
||||
return []string{weights}, nil
|
||||
}
|
||||
entries, err := os.ReadDir(weights)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var out []string
|
||||
for _, e := range entries {
|
||||
if e.Type().IsRegular() && !strings.HasPrefix(e.Name(), ".") {
|
||||
out = append(out, filepath.Join(weights, e.Name()))
|
||||
}
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func isWeightsFile(path string) bool {
|
||||
switch strings.ToLower(filepath.Ext(path)) {
|
||||
case ".safetensors", ".ckpt", ".pt", ".pth", ".bin", ".gguf", ".sft":
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// LinkWeights shows ComfyUI the weights: a link in dir to the file, or to
|
||||
// every file of the directory. Links made before are taken away first, so
|
||||
// a replica started again on other weights sees only those.
|
||||
@@ -380,3 +516,71 @@ func relay(r io.Reader, w io.Writer) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// HFRepoEnv is where the agent hands the gate the repository a custom node
|
||||
// loads the weights by name from.
|
||||
const HFRepoEnv = "LLMGW_COMFYUI_HF_REPO"
|
||||
|
||||
// hfHubDir is the Hugging Face cache of the user the gate runs as.
|
||||
func hfHubDir() string {
|
||||
if d := os.Getenv("HF_HUB_CACHE"); d != "" {
|
||||
return d
|
||||
}
|
||||
if d := os.Getenv("HF_HOME"); d != "" {
|
||||
return filepath.Join(d, "hub")
|
||||
}
|
||||
home, _ := os.UserHomeDir()
|
||||
return filepath.Join(home, ".cache", "huggingface", "hub")
|
||||
}
|
||||
|
||||
// LinkHFCache shows the weights to a node that loads them by repository
|
||||
// name: a snapshot of repo in the Hugging Face cache at hub, each file a link
|
||||
// to the weights, refs/main naming it. huggingface_hub then answers from the
|
||||
// cache, and a gated repository needs no token on the node.
|
||||
func LinkHFCache(weights, repo, hub string) error {
|
||||
owner, name, ok := strings.Cut(repo, "/")
|
||||
if !ok || owner == "" || name == "" || strings.Contains(name, "/") || strings.Contains(repo, "..") || strings.Contains(repo, "\\") {
|
||||
return fmt.Errorf("%q is not owner/name", repo)
|
||||
}
|
||||
weights, err := filepath.Abs(weights)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// The snapshot is named as a commit is, which is what refs/main must
|
||||
// hold, and by the weights, so other weights are another snapshot.
|
||||
sum := sha1.Sum([]byte(weights)) //nolint:gosec // a name, not a secret
|
||||
revision := hex.EncodeToString(sum[:])
|
||||
info, err := os.Stat(weights)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
files := []string{weights}
|
||||
if info.IsDir() {
|
||||
entries, err := os.ReadDir(weights)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
files = files[:0]
|
||||
for _, e := range entries {
|
||||
if !e.IsDir() && !strings.HasPrefix(e.Name(), ".") {
|
||||
files = append(files, filepath.Join(weights, e.Name()))
|
||||
}
|
||||
}
|
||||
}
|
||||
root := filepath.Join(hub, "models--"+owner+"--"+name)
|
||||
snap := filepath.Join(root, "snapshots", revision)
|
||||
// Made again each time: links to weights that moved must not stay.
|
||||
_ = os.RemoveAll(snap)
|
||||
if err := os.MkdirAll(snap, 0o755); err != nil {
|
||||
return err
|
||||
}
|
||||
for _, f := range files {
|
||||
if err := os.Symlink(f, filepath.Join(snap, FileName(f))); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if err := os.MkdirAll(filepath.Join(root, "refs"), 0o755); err != nil {
|
||||
return err
|
||||
}
|
||||
return os.WriteFile(filepath.Join(root, "refs", "main"), []byte(revision), 0o644) //nolint:gosec // not secret
|
||||
}
|
||||
@@ -250,3 +250,52 @@ func TestComfyUIKeepsWritingWhenWhatTheGateWritesToIsGone(t *testing.T) {
|
||||
t.Fatalf("ComfyUI answered %d times; output it could not hand on stopped it", ok)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLLMGWsOwnNodesArePutInEveryReplica(t *testing.T) {
|
||||
state := t.TempDir()
|
||||
if err := installOwnNodes(state); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
b, err := os.ReadFile(filepath.Join(state, "custom_nodes", "llmgw_nodes", "__init__.py"))
|
||||
if err != nil || !strings.Contains(string(b), "LLMGWPrepareForMesh") {
|
||||
t.Fatalf("%v %.80s", err, b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestASharedReplicaSeesEveryMembersWeights(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
write := func(p string) string {
|
||||
full := filepath.Join(root, p)
|
||||
_ = os.MkdirAll(filepath.Dir(full), 0o755)
|
||||
if err := os.WriteFile(full, []byte("w"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return full
|
||||
}
|
||||
flux := write("flux1-schnell-fp8.safetensors")
|
||||
write("sf3d/model.safetensors")
|
||||
write("sf3d/README.md")
|
||||
write("tripo/model.ckpt")
|
||||
write("tripo/README.md")
|
||||
dir := filepath.Join(root, "models")
|
||||
if err := LinkAllWeights([]string{flux, filepath.Join(root, "sf3d"), filepath.Join(root, "tripo")}, dir); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for _, want := range []string{"flux1-schnell-fp8.safetensors", "model.safetensors", "model.ckpt", "README.md"} {
|
||||
if _, err := os.Lstat(filepath.Join(dir, want)); err != nil {
|
||||
t.Errorf("%s not linked: %v", want, err)
|
||||
}
|
||||
}
|
||||
// Two weights of one name: ComfyUI would load one for both.
|
||||
write("other/model.safetensors")
|
||||
err := LinkAllWeights([]string{filepath.Join(root, "sf3d"), filepath.Join(root, "other")}, dir)
|
||||
if err == nil || !strings.Contains(err.Error(), "both named model.safetensors") {
|
||||
t.Errorf("err %v", err)
|
||||
}
|
||||
if ms, err := parseShared(`[{"name":"sf3d","path":"/x","hf_repo":"stabilityai/stable-fast-3d"}]`); err != nil || ms[0].HFRepo == "" {
|
||||
t.Errorf("parse %+v %v", ms, err)
|
||||
}
|
||||
if _, err := parseShared(`[{"name":"sf3d"}]`); err == nil {
|
||||
t.Error("a member with no path was taken")
|
||||
}
|
||||
}
|
||||
+170
-3
@@ -2,13 +2,18 @@ package comfy
|
||||
|
||||
import (
|
||||
"context"
|
||||
"embed"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"runtime"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
@@ -23,6 +28,31 @@ type Node struct {
|
||||
Repo string `json:"repo"`
|
||||
Commit string `json:"commit"`
|
||||
Requirements []string `json:"requirements,omitempty"`
|
||||
// Build are directories of the node that are packages to compile.
|
||||
Build []string `json:"build,omitempty"`
|
||||
}
|
||||
|
||||
//go:embed all:nodes
|
||||
var ownNodes embed.FS
|
||||
|
||||
// installOwnNodes writes llmgw's own nodes into a replica's custom_nodes:
|
||||
// what every workflow may use, from the binary rather than a repository,
|
||||
// written again at every start so a replica runs the gate's own version.
|
||||
func installOwnNodes(state string) error {
|
||||
return fs.WalkDir(ownNodes, "nodes", func(p string, d fs.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
dst := filepath.Join(state, "custom_nodes", strings.TrimPrefix(p, "nodes"))
|
||||
if d.IsDir() {
|
||||
return os.MkdirAll(dst, 0o755)
|
||||
}
|
||||
b, err := ownNodes.ReadFile(p)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return os.WriteFile(dst, b, 0o644) //nolint:gosec // code ComfyUI reads, not secret
|
||||
})
|
||||
}
|
||||
|
||||
// NodesEnv is where the agent hands the gate a model's custom nodes.
|
||||
@@ -40,12 +70,17 @@ func installNodes(ctx context.Context, state, python string, nodes []Node, uv st
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(ctx, 20*time.Minute)
|
||||
defer cancel()
|
||||
var reqs []string
|
||||
var reqs, built []string
|
||||
for _, n := range nodes {
|
||||
name := nodeDir.ReplaceAllString(strings.TrimSuffix(path.Base(n.Repo), ".git"), "_")
|
||||
dir := filepath.Join(state, "custom_nodes", name)
|
||||
if head, err := gitOutput(ctx, dir, "rev-parse", "HEAD"); err == nil && head == n.Commit {
|
||||
reqs = append(reqs, n.Requirements...)
|
||||
wheels, err := buildNode(ctx, n, dir, python, uv, out)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
built = append(built, wheels...)
|
||||
continue
|
||||
}
|
||||
out(fmt.Sprintf("custom node %s at %s", n.Repo, n.Commit[:12]))
|
||||
@@ -61,13 +96,25 @@ func installNodes(ctx context.Context, state, python string, nodes []Node, uv st
|
||||
}
|
||||
}
|
||||
reqs = append(reqs, n.Requirements...)
|
||||
wheels, err := buildNode(ctx, n, dir, python, uv, out)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
built = append(built, wheels...)
|
||||
}
|
||||
if len(reqs) == 0 {
|
||||
if len(reqs) == 0 && len(built) == 0 {
|
||||
return "", nil
|
||||
}
|
||||
if uv == "" {
|
||||
return "", fmt.Errorf("custom nodes need %s, and no uv is installed to install them with", strings.Join(reqs, ", "))
|
||||
}
|
||||
// A built package is named by its wheel; ComfyUI's own copy, if one was
|
||||
// ever put there, must not pin it to another.
|
||||
named := slices.Clone(reqs)
|
||||
for _, w := range built {
|
||||
named = append(named, wheelPackage(w))
|
||||
}
|
||||
reqs = append(reqs, built...)
|
||||
site := filepath.Join(state, "site")
|
||||
marker := filepath.Join(site, ".llmgw-requirements")
|
||||
want := strings.Join(reqs, "\n")
|
||||
@@ -83,7 +130,7 @@ func installNodes(ctx context.Context, state, python string, nodes []Node, uv st
|
||||
return "", fmt.Errorf("reading ComfyUI's packages: %w", err)
|
||||
}
|
||||
constraints := filepath.Join(state, "constraints.txt")
|
||||
if err := os.WriteFile(constraints, withoutNamed(freeze, reqs), 0o644); err != nil { //nolint:gosec // not secret
|
||||
if err := os.WriteFile(constraints, withoutNamed(freeze, named), 0o644); err != nil { //nolint:gosec // not secret
|
||||
return "", err
|
||||
}
|
||||
_ = os.RemoveAll(site)
|
||||
@@ -165,3 +212,123 @@ func packageName(spec string) string {
|
||||
}
|
||||
return strings.NewReplacer("_", "-", ".", "-").Replace(strings.ToLower(s))
|
||||
}
|
||||
|
||||
// Packages a node's repository has that no index does — C++ and CUDA
|
||||
// extensions — are built here, for the card the replica runs on: a CUDA
|
||||
// kernel compiled for one architecture does not load on another, and a
|
||||
// site's cards are not the PoC's. A build is minutes; its wheel is kept on
|
||||
// the node, by the node's commit, the directory and the architecture, for
|
||||
// the next replica on the same kind of card.
|
||||
|
||||
// cudaArch is the compute capability of the card the replica sees, as
|
||||
// TORCH_CUDA_ARCH_LIST wants it ("7.5"). A var for the tests.
|
||||
var cudaArch = func(ctx context.Context, python string) (string, error) {
|
||||
cmd := exec.CommandContext(ctx, python, "-c", //nolint:gosec // the agent's own Python
|
||||
"import torch; print('%d.%d' % torch.cuda.get_device_capability())")
|
||||
b, err := cmd.Output()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("asking torch for the card's compute capability: %v", err)
|
||||
}
|
||||
return strings.TrimSpace(string(b)), nil
|
||||
}
|
||||
|
||||
// buildWheel builds the package in dir as a wheel into outDir, with
|
||||
// ComfyUI's Python and what it already has (torch, setuptools): a CUDA
|
||||
// extension builds against the torch it will load with. A var for the tests.
|
||||
var buildWheel = func(ctx context.Context, uv, python, dir, outDir string, env []string) ([]byte, error) {
|
||||
cmd := exec.CommandContext(ctx, uv, "build", "--wheel", "--no-build-isolation", //nolint:gosec // the catalog's node, at its commit
|
||||
"--python", python, "--out-dir", outDir, dir)
|
||||
cmd.Env = env
|
||||
return cmd.CombinedOutput()
|
||||
}
|
||||
|
||||
// buildCache is where built wheels are kept: under the engines' home, which
|
||||
// outlives a replica.
|
||||
func buildCache() string {
|
||||
if d, err := os.UserCacheDir(); err == nil {
|
||||
return filepath.Join(d, "llmgw", "node-builds")
|
||||
}
|
||||
return filepath.Join(os.TempDir(), "llmgw-node-builds")
|
||||
}
|
||||
|
||||
// buildNode builds each of a node's packages that are compiled, or finds the
|
||||
// wheel built before for this commit and card, and returns the wheels.
|
||||
func buildNode(ctx context.Context, n Node, dir, python, uv string, out func(string)) ([]string, error) {
|
||||
if len(n.Build) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
if uv == "" {
|
||||
return nil, fmt.Errorf("custom node %s has packages to build, and no uv is installed to build them with", n.Repo)
|
||||
}
|
||||
arch, err := cudaArch(ctx, python)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("custom node %s: %w", n.Repo, err)
|
||||
}
|
||||
cudaHome := os.Getenv("CUDA_HOME")
|
||||
if cudaHome == "" {
|
||||
for _, c := range []string{"/usr/local/cuda"} {
|
||||
if _, err := os.Stat(filepath.Join(c, "bin", "nvcc")); err == nil {
|
||||
cudaHome = c
|
||||
}
|
||||
}
|
||||
}
|
||||
var wheels []string
|
||||
for _, sub := range n.Build {
|
||||
cached := filepath.Join(buildCache(), n.Commit[:12], "sm"+strings.ReplaceAll(arch, ".", ""), nodeDir.ReplaceAllString(sub, "_"))
|
||||
if w, ok := firstWheel(cached); ok {
|
||||
wheels = append(wheels, w)
|
||||
continue
|
||||
}
|
||||
if cudaHome == "" {
|
||||
return nil, fmt.Errorf("custom node %s: %s is compiled, and this node has no CUDA toolkit (no nvcc in "+
|
||||
"CUDA_HOME or /usr/local/cuda) to compile it with", n.Repo, sub)
|
||||
}
|
||||
out(fmt.Sprintf("building %s of %s for compute %s", sub, n.Repo, arch))
|
||||
// Built beside where it is kept and moved there whole: two replicas
|
||||
// starting at once on one node must not see half a wheel.
|
||||
if err := os.MkdirAll(filepath.Dir(cached), 0o755); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
tmp, err := os.MkdirTemp(filepath.Dir(cached), ".build-")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
env := append(os.Environ(), "TORCH_CUDA_ARCH_LIST="+arch, "CUDA_HOME="+cudaHome,
|
||||
"PATH="+filepath.Join(cudaHome, "bin")+string(os.PathListSeparator)+os.Getenv("PATH"),
|
||||
"UV_NO_CONFIG=1", "MAX_JOBS="+strconv.Itoa(max(runtime.NumCPU(), 1)))
|
||||
b, err := buildWheel(ctx, uv, python, filepath.Join(dir, sub), tmp, env)
|
||||
if err != nil {
|
||||
_ = os.RemoveAll(tmp)
|
||||
return nil, fmt.Errorf("custom node %s: building %s: %v: %s", n.Repo, sub, err, lastLines(b))
|
||||
}
|
||||
if _, ok := firstWheel(tmp); !ok {
|
||||
_ = os.RemoveAll(tmp)
|
||||
return nil, fmt.Errorf("custom node %s: building %s made no wheel: %s", n.Repo, sub, lastLines(b))
|
||||
}
|
||||
if err := os.Rename(tmp, cached); err != nil {
|
||||
_ = os.RemoveAll(tmp)
|
||||
// Another replica got there first: its wheel is as good.
|
||||
if _, ok := firstWheel(cached); !ok {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
w, _ := firstWheel(cached)
|
||||
wheels = append(wheels, w)
|
||||
}
|
||||
return wheels, nil
|
||||
}
|
||||
|
||||
func firstWheel(dir string) (string, bool) {
|
||||
m, _ := filepath.Glob(filepath.Join(dir, "*.whl"))
|
||||
if len(m) == 0 {
|
||||
return "", false
|
||||
}
|
||||
return m[0], true
|
||||
}
|
||||
|
||||
// wheelPackage is the package a wheel file is of: its name up to the first
|
||||
// '-', as PyPI compares names.
|
||||
func wheelPackage(wheel string) string {
|
||||
name, _, _ := strings.Cut(filepath.Base(wheel), "-")
|
||||
return packageName(name)
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
"""llmgw's own ComfyUI nodes, put in every replica by the gate.
|
||||
|
||||
LLMGWPrepareForMesh is what an image-to-3D model wants of its picture, as
|
||||
TripoSR's own pipeline (tsr/utils.py) does it: the background taken away —
|
||||
by the picture's alpha where it has one, by rembg (MIT; u2net, Apache 2.0)
|
||||
where it does not — the object cropped to its bounds, set square in the
|
||||
middle at a ratio of the side, on grey.
|
||||
"""
|
||||
|
||||
import numpy as np
|
||||
import torch
|
||||
from PIL import Image
|
||||
|
||||
_sessions = {}
|
||||
|
||||
|
||||
def _rembg(img, model):
|
||||
try:
|
||||
import rembg
|
||||
except ImportError as e: # a model that wants it names it in its nodes' requirements
|
||||
raise RuntimeError("the picture has no alpha and rembg is not installed for this model: "
|
||||
"add rembg and onnxruntime to its custom node requirements") from e
|
||||
if model not in _sessions:
|
||||
_sessions[model] = rembg.new_session(model)
|
||||
return rembg.remove(img, session=_sessions[model])
|
||||
|
||||
|
||||
def _fit(rgba, ratio):
|
||||
"""tsr.utils.resize_foreground: crop to the alpha's bounds, pad square,
|
||||
pad again so the object is ratio of the side."""
|
||||
a = np.array(rgba)
|
||||
ys, xs = np.where(a[..., 3] > 0)
|
||||
if len(ys) == 0:
|
||||
raise RuntimeError("nothing is left of the picture once its background is taken away")
|
||||
fg = a[ys.min():ys.max() + 1, xs.min():xs.max() + 1]
|
||||
size = max(fg.shape[0], fg.shape[1])
|
||||
ph0, pw0 = (size - fg.shape[0]) // 2, (size - fg.shape[1]) // 2
|
||||
sq = np.pad(fg, ((ph0, size - fg.shape[0] - ph0), (pw0, size - fg.shape[1] - pw0), (0, 0)))
|
||||
new = int(size / ratio)
|
||||
ph0, pw0 = (new - size) // 2, (new - size) // 2
|
||||
return np.pad(sq, ((ph0, new - size - ph0), (pw0, new - size - pw0), (0, 0)))
|
||||
|
||||
|
||||
class LLMGWPrepareForMesh:
|
||||
@classmethod
|
||||
def INPUT_TYPES(cls):
|
||||
return {
|
||||
"required": {
|
||||
"image": ("IMAGE",),
|
||||
"foreground_ratio": ("FLOAT", {"default": 0.85, "min": 0.3, "max": 1.0, "step": 0.01}),
|
||||
"background": ("FLOAT", {"default": 0.5, "min": 0.0, "max": 1.0, "step": 0.01}),
|
||||
"remove_background": (["auto", "always", "never"],),
|
||||
"rembg_model": (["u2net", "isnet-general-use", "u2netp"],),
|
||||
},
|
||||
"optional": {"mask": ("MASK",)},
|
||||
}
|
||||
|
||||
RETURN_TYPES = ("IMAGE", "MASK")
|
||||
RETURN_NAMES = ("image", "mask")
|
||||
FUNCTION = "prepare"
|
||||
CATEGORY = "llmgw"
|
||||
|
||||
def prepare(self, image, foreground_ratio, background, remove_background, rembg_model, mask=None):
|
||||
out = []
|
||||
for i in range(image.shape[0]):
|
||||
rgb = (image[i].cpu().numpy() * 255).clip(0, 255).astype(np.uint8)
|
||||
h, w = rgb.shape[:2]
|
||||
alpha = None
|
||||
# LoadImage's mask is 1 - alpha, and a 64x64 of zeros for a
|
||||
# picture with none.
|
||||
if mask is not None and remove_background != "always":
|
||||
m = mask[min(i, mask.shape[0] - 1)].cpu().numpy()
|
||||
if m.shape == (h, w) and m.max() > 0:
|
||||
alpha = ((1.0 - m) * 255).clip(0, 255).astype(np.uint8)
|
||||
if alpha is None and remove_background != "never":
|
||||
rgba = np.array(_rembg(Image.fromarray(rgb), rembg_model).convert("RGBA"))
|
||||
else:
|
||||
if alpha is None:
|
||||
alpha = np.full((h, w), 255, np.uint8)
|
||||
rgba = np.dstack([rgb, alpha])
|
||||
sq = _fit(rgba, foreground_ratio).astype(np.float32) / 255.0
|
||||
a = sq[..., 3:4]
|
||||
img = sq[..., :3] * a + (1.0 - a) * background
|
||||
out.append(torch.from_numpy(np.dstack([img, a])))
|
||||
# One size for the batch: the first picture's.
|
||||
side = out[0].shape[0]
|
||||
out = [o if o.shape[0] == side else torch.from_numpy(
|
||||
np.array(Image.fromarray((o.numpy() * 255).astype(np.uint8)).resize((side, side)))).float() / 255.0
|
||||
for o in out]
|
||||
both = torch.stack(out)
|
||||
# The picture on its background, and the object's alpha as a mask
|
||||
# (1 where the object is) for a model that wants it, as Stable Fast
|
||||
# 3D's sampler does.
|
||||
return (both[..., :3].contiguous(), both[..., 3].contiguous())
|
||||
|
||||
|
||||
def _to_linear(x):
|
||||
return np.where(x <= 0.04045, x / 12.92, ((x + 0.055) / 1.055) ** 2.4)
|
||||
|
||||
|
||||
def _to_srgb(x):
|
||||
return np.where(x <= 0.0031308, x * 12.92, 1.055 * np.power(np.clip(x, 0, None), 1 / 2.4) - 0.055)
|
||||
|
||||
|
||||
def _match_albedo(tex, reference, mask):
|
||||
"""The texture's brightness brought to the picture's: Stable Fast 3D
|
||||
takes the light out of what it sees, and a dark object it reads as a
|
||||
light one dimly lit — a basalt of 0.17 came back 0.67. Scaled in linear
|
||||
light by the ratio of the medians over the object, so its marks keep
|
||||
their contrast; texels nothing maps to (black) are left as they are."""
|
||||
t = np.asarray(tex.convert("RGB")).astype(np.float64) / 255.0
|
||||
used = t.max(-1) > 2 / 255
|
||||
ref = reference.cpu().numpy().astype(np.float64)
|
||||
obj = mask.cpu().numpy() > 0.5 if mask is not None else np.ones(ref.shape[:2], bool)
|
||||
if used.sum() < 16 or obj.sum() < 16:
|
||||
return tex
|
||||
lum = lambda a: a @ np.array([0.2126, 0.7152, 0.0722])
|
||||
want = np.median(lum(_to_linear(ref[obj])))
|
||||
have = np.median(lum(_to_linear(t[used])))
|
||||
if have <= 0:
|
||||
return tex
|
||||
k = float(np.clip(want / have, 0.05, 20.0))
|
||||
out = t.copy()
|
||||
out[used] = np.clip(_to_srgb(_to_linear(t[used]) * k), 0, 1)
|
||||
img = Image.fromarray((out * 255 + 0.5).astype(np.uint8))
|
||||
img.format = tex.format
|
||||
return img
|
||||
|
||||
|
||||
class LLMGWSaveMesh:
|
||||
"""Writes each mesh a 3D node made to output/ as a GLB and names the
|
||||
files, which is how the gate finds a result. A model's own save node
|
||||
may return the mesh as base64 (Stable Fast 3D's does) or as an OBJ
|
||||
without its texture, and the gate reads neither.
|
||||
|
||||
With albedo_match and the picture the mesh was made from (and its
|
||||
mask), the mesh's base colour is brought to the picture's brightness."""
|
||||
|
||||
@classmethod
|
||||
def INPUT_TYPES(cls):
|
||||
return {"required": {"mesh": ("MESH",), "filename_prefix": ("STRING", {"default": "mesh"})},
|
||||
"optional": {"albedo_match": ("BOOLEAN", {"default": False}),
|
||||
"reference": ("IMAGE",), "reference_mask": ("MASK",)}}
|
||||
|
||||
RETURN_TYPES = ()
|
||||
OUTPUT_NODE = True
|
||||
FUNCTION = "save"
|
||||
CATEGORY = "llmgw"
|
||||
|
||||
def save(self, mesh, filename_prefix="mesh", albedo_match=False, reference=None, reference_mask=None):
|
||||
import os
|
||||
import folder_paths
|
||||
import trimesh
|
||||
from trimesh.exchange import gltf
|
||||
|
||||
folder, name, counter, subfolder, _ = folder_paths.get_save_image_path(
|
||||
filename_prefix, folder_paths.get_output_directory())
|
||||
saved = []
|
||||
for i, m in enumerate(mesh if isinstance(mesh, (list, tuple)) else [mesh]):
|
||||
if albedo_match and reference is not None:
|
||||
_match_scene(m, reference[min(i, reference.shape[0] - 1)],
|
||||
None if reference_mask is None else reference_mask[min(i, reference_mask.shape[0] - 1)])
|
||||
file = f"{name.replace('%batch_num%', str(i))}_{counter + i:05}_.glb"
|
||||
scene = m if isinstance(m, trimesh.Scene) else trimesh.Scene(m)
|
||||
with open(os.path.join(folder, file), "wb") as f:
|
||||
f.write(gltf.export_glb(scene, include_normals=True))
|
||||
saved.append({"filename": file, "type": "output", "subfolder": subfolder})
|
||||
return {"ui": {"mesh": saved}}
|
||||
|
||||
|
||||
def _match_scene(m, reference, mask):
|
||||
"""_match_albedo on every base colour texture of a mesh or scene."""
|
||||
geoms = m.geometry.values() if hasattr(m, "geometry") else [m]
|
||||
for g in geoms:
|
||||
mat = getattr(getattr(g, "visual", None), "material", None)
|
||||
tex = getattr(mat, "baseColorTexture", None)
|
||||
if tex is not None:
|
||||
mat.baseColorTexture = _match_albedo(tex, reference, mask)
|
||||
|
||||
|
||||
NODE_CLASS_MAPPINGS = {"LLMGWPrepareForMesh": LLMGWPrepareForMesh, "LLMGWSaveMesh": LLMGWSaveMesh}
|
||||
NODE_DISPLAY_NAME_MAPPINGS = {"LLMGWPrepareForMesh": "Prepare a picture for a 3D model (llmgw)",
|
||||
"LLMGWSaveMesh": "Save a mesh as GLB (llmgw)"}
|
||||
@@ -0,0 +1,165 @@
|
||||
package comfy
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// fakeUV is a uv that answers pip freeze with ComfyUI's packages and records
|
||||
// what pip install was given.
|
||||
func fakeUV(t *testing.T, freeze string) (uv, log string) {
|
||||
t.Helper()
|
||||
dir := t.TempDir()
|
||||
log = filepath.Join(dir, "install.log")
|
||||
uv = filepath.Join(dir, "uv")
|
||||
script := "#!/bin/sh\nif [ \"$2\" = freeze ]; then printf '%s' '" + freeze + "'; exit 0; fi\n" +
|
||||
"echo \"$@\" >> " + log + "\n" +
|
||||
"prev=; for a in \"$@\"; do if [ \"$prev\" = --target ]; then mkdir -p \"$a\"; fi; prev=$a; done\nexit 0\n"
|
||||
if err := os.WriteFile(uv, []byte(script), 0o755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return uv, log
|
||||
}
|
||||
|
||||
func gitRepo(t *testing.T, files map[string]string) (repo, commit string) {
|
||||
t.Helper()
|
||||
if _, err := exec.LookPath("git"); err != nil {
|
||||
t.Skip("no git")
|
||||
}
|
||||
repo = t.TempDir()
|
||||
run := func(args ...string) string {
|
||||
cmd := exec.Command("git", args...)
|
||||
cmd.Dir = repo
|
||||
cmd.Env = append(os.Environ(), "GIT_AUTHOR_NAME=t", "GIT_AUTHOR_EMAIL=t@t", "GIT_COMMITTER_NAME=t", "GIT_COMMITTER_EMAIL=t@t")
|
||||
b, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
t.Fatalf("git %v: %v %s", args, err, b)
|
||||
}
|
||||
return strings.TrimSpace(string(b))
|
||||
}
|
||||
run("init", "-q")
|
||||
run("config", "uploadpack.allowReachableSHA1InWant", "true")
|
||||
for name, body := range files {
|
||||
_ = os.MkdirAll(filepath.Dir(filepath.Join(repo, name)), 0o755)
|
||||
_ = os.WriteFile(filepath.Join(repo, name), []byte(body), 0o644)
|
||||
}
|
||||
run("add", ".")
|
||||
run("commit", "-qm", "one")
|
||||
return repo, run("rev-parse", "HEAD")
|
||||
}
|
||||
|
||||
func TestANodesCompiledPackagesAreBuiltForTheCardOnceAndInstalledBesideTheReplica(t *testing.T) {
|
||||
repo, commit := gitRepo(t, map[string]string{"__init__.py": "", "texture_baker/setup.py": "", "uv_unwrapper/setup.py": ""})
|
||||
t.Setenv("XDG_CACHE_HOME", t.TempDir())
|
||||
t.Setenv("HOME", t.TempDir())
|
||||
cuda := t.TempDir()
|
||||
_ = os.MkdirAll(filepath.Join(cuda, "bin"), 0o755)
|
||||
_ = os.WriteFile(filepath.Join(cuda, "bin", "nvcc"), nil, 0o755)
|
||||
t.Setenv("CUDA_HOME", cuda)
|
||||
|
||||
var builds atomic.Int32
|
||||
var envSeen []string
|
||||
oldArch, oldBuild := cudaArch, buildWheel
|
||||
t.Cleanup(func() { cudaArch, buildWheel = oldArch, oldBuild })
|
||||
cudaArch = func(context.Context, string) (string, error) { return "7.5", nil }
|
||||
buildWheel = func(_ context.Context, _, _, dir, out string, env []string) ([]byte, error) {
|
||||
builds.Add(1)
|
||||
envSeen = env
|
||||
name := strings.ReplaceAll(filepath.Base(dir), "_", "-")
|
||||
return nil, os.WriteFile(filepath.Join(out, strings.ReplaceAll(name, "-", "_")+"-0.0.1-cp312-cp312-linux_x86_64.whl"), []byte("w"), 0o644)
|
||||
}
|
||||
// ComfyUI's environment has an old hand-installed copy, which must not
|
||||
// pin the built one.
|
||||
uv, log := fakeUV(t, "numpy==2.5.3\ntexture-baker @ file:///home/someone/texture_baker-0.0.1.whl\n")
|
||||
node := Node{Repo: "file://" + repo, Commit: commit, Requirements: []string{"trimesh"},
|
||||
Build: []string{"texture_baker", "uv_unwrapper"}}
|
||||
|
||||
state := t.TempDir()
|
||||
site, err := installNodes(t.Context(), state, "python3", []Node{node}, uv, func(string) {})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if site == "" || builds.Load() != 2 {
|
||||
t.Fatalf("site %q, %d builds", site, builds.Load())
|
||||
}
|
||||
if !strings.Contains(strings.Join(envSeen, " "), "TORCH_CUDA_ARCH_LIST=7.5") {
|
||||
t.Error("the build was not told the card's architecture")
|
||||
}
|
||||
installed, _ := os.ReadFile(log)
|
||||
if !strings.Contains(string(installed), "trimesh") || !strings.Contains(string(installed), "sm75/texture_baker/texture_baker-0.0.1") ||
|
||||
!strings.Contains(string(installed), "uv_unwrapper-0.0.1") {
|
||||
t.Errorf("installed %s", installed)
|
||||
}
|
||||
constraints, _ := os.ReadFile(filepath.Join(state, "constraints.txt"))
|
||||
if strings.Contains(string(constraints), "texture-baker") || !strings.Contains(string(constraints), "numpy==2.5.3") {
|
||||
t.Errorf("constraints %s", constraints)
|
||||
}
|
||||
|
||||
// A second replica on the same kind of card finds the wheels built.
|
||||
if _, err := installNodes(t.Context(), t.TempDir(), "python3", []Node{node}, uv, func(string) {}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if builds.Load() != 2 {
|
||||
t.Errorf("built again: %d builds", builds.Load())
|
||||
}
|
||||
// Another kind of card builds its own.
|
||||
cudaArch = func(context.Context, string) (string, error) { return "8.9", nil }
|
||||
if _, err := installNodes(t.Context(), t.TempDir(), "python3", []Node{node}, uv, func(string) {}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if builds.Load() != 4 {
|
||||
t.Errorf("an Ada used Turing's wheels: %d builds", builds.Load())
|
||||
}
|
||||
}
|
||||
|
||||
func TestANodeToCompileOnAMachineWithoutCUDASaysSo(t *testing.T) {
|
||||
repo, commit := gitRepo(t, map[string]string{"__init__.py": "", "ext/setup.py": ""})
|
||||
t.Setenv("XDG_CACHE_HOME", t.TempDir())
|
||||
t.Setenv("HOME", t.TempDir())
|
||||
t.Setenv("CUDA_HOME", "")
|
||||
if _, err := os.Stat("/usr/local/cuda/bin/nvcc"); err == nil {
|
||||
t.Skip("this machine has a CUDA toolkit")
|
||||
}
|
||||
oldArch := cudaArch
|
||||
t.Cleanup(func() { cudaArch = oldArch })
|
||||
cudaArch = func(context.Context, string) (string, error) { return "8.0", nil }
|
||||
uv, _ := fakeUV(t, "")
|
||||
_, err := installNodes(t.Context(), t.TempDir(), "python3", []Node{{Repo: "file://" + repo, Commit: commit, Build: []string{"ext"}}},
|
||||
uv, func(string) {})
|
||||
if err == nil || !strings.Contains(err.Error(), "no CUDA toolkit") {
|
||||
t.Errorf("%v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWeightsANodeLoadsByRepositoryNameAreInTheHuggingFaceCache(t *testing.T) {
|
||||
weights := t.TempDir()
|
||||
_ = os.WriteFile(filepath.Join(weights, "config.yaml"), []byte("c"), 0o644)
|
||||
_ = os.WriteFile(filepath.Join(weights, "model.safetensors"), []byte("m"), 0o644)
|
||||
hub := t.TempDir()
|
||||
if err := LinkHFCache(weights, "stabilityai/stable-fast-3d", hub); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
root := filepath.Join(hub, "models--stabilityai--stable-fast-3d")
|
||||
ref, _ := os.ReadFile(filepath.Join(root, "refs", "main"))
|
||||
if len(ref) != 40 {
|
||||
t.Fatalf("refs/main %q is not a commit's form", ref)
|
||||
}
|
||||
b, err := os.ReadFile(filepath.Join(root, "snapshots", string(ref), "model.safetensors"))
|
||||
if err != nil || string(b) != "m" {
|
||||
t.Errorf("the weights through the cache: %q %v", b, err)
|
||||
}
|
||||
// Again, as a replica started a second time does.
|
||||
if err := LinkHFCache(weights, "stabilityai/stable-fast-3d", hub); err != nil {
|
||||
t.Errorf("a second time: %v", err)
|
||||
}
|
||||
for _, bad := range []string{"noslash", "a/b/c", "../x", "a/.."} {
|
||||
if err := LinkHFCache(weights, bad, hub); err == nil {
|
||||
t.Errorf("%q taken for a repository", bad)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -60,7 +60,7 @@ func TestTheGateHearsTheWorkflowsItLetsThrough(t *testing.T) {
|
||||
defer comfy.Close()
|
||||
u, _ := url.Parse(comfy.URL)
|
||||
book := newProgressBook()
|
||||
gate := httptest.NewServer(newGate(u, "", "m", book, "llmgw-gate-1"))
|
||||
gate := httptest.NewServer(newGate(u, "", []string{"m"}, book, "llmgw-gate-1"))
|
||||
defer gate.Close()
|
||||
resp, err := http.Post(gate.URL+"/prompt", "application/json", strings.NewReader(`{"prompt":{},"client_id":"router"}`))
|
||||
if err != nil {
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"1": {"class_type": "LoadImage", "inputs": {"image": "{{image}}"}},
|
||||
"5": {"class_type": "LLMGWPrepareForMesh", "inputs": {"image": ["1", 0], "mask": ["1", 1],
|
||||
"foreground_ratio": 0.85, "background": 0.5, "remove_background": "auto", "rembg_model": "u2net"}},
|
||||
"2": {"class_type": "TripoSRModelLoader", "inputs": {"model": "{{checkpoint}}", "chunk_size": 8192}},
|
||||
"3": {"class_type": "TripoSRSampler", "inputs": {"model": ["2", 0], "reference_image": ["5", 0],
|
||||
"geometry_resolution": "{{resolution|256}}", "threshold": 25.0}},
|
||||
"4": {"class_type": "TripoSRViewer", "inputs": {"mesh": ["3", 0]}}
|
||||
}
|
||||
@@ -158,6 +158,13 @@ type Server struct {
|
||||
// Firewall turns llmgw's firewall on every machine on or off.
|
||||
Firewall FirewallSettings `koanf:"firewall"`
|
||||
|
||||
// Presets is how the models that come with llmgw reach the catalog.
|
||||
Presets PresetSettings `koanf:"presets"`
|
||||
|
||||
// OnDemand is how models that load when asked for take turns on the
|
||||
// cards.
|
||||
OnDemand OnDemandSettings `koanf:"on_demand"`
|
||||
|
||||
// Agents are the nodes' agent settings: agent.yaml's keys but those an
|
||||
// agent needs to start, for every node (default) and for one
|
||||
// (nodes.<id>). Sent to the agents as they change; an agent whose
|
||||
@@ -795,6 +802,7 @@ func Default() Server {
|
||||
MaxConnections: 10_000,
|
||||
Mirror: Mirror{UpdateCheck: 6 * time.Hour},
|
||||
Firewall: FirewallSettings{Enabled: true},
|
||||
Presets: PresetSettings{Auto: true},
|
||||
Control: Control{
|
||||
Interval: 5 * time.Second,
|
||||
BaseBackoff: 10 * time.Second,
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
package config
|
||||
|
||||
import "time"
|
||||
|
||||
// OnDemandSettings is how models that load when asked for take turns on the
|
||||
// cards: on a site with fewer cards than such models, the wait between one
|
||||
// and the next.
|
||||
type OnDemandSettings struct {
|
||||
// EvictAfterIdle is how long an on-demand replica must go unasked-for
|
||||
// before a model that wants its card may have it. Zero keeps 2m.
|
||||
EvictAfterIdle time.Duration `koanf:"evict_after_idle"`
|
||||
// MinLifetime is how long a replica that has just come up is safe from
|
||||
// that, so two models do not take turns paying for loads. Zero keeps
|
||||
// 5m. On one card shared by a picture model and a 3D model, 1m each
|
||||
// brings the wait between a picture and its mesh to about a minute.
|
||||
// Both are in force on the leader within seconds.
|
||||
MinLifetime time.Duration `koanf:"min_lifetime"`
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
package config
|
||||
|
||||
// PresetSettings is how the models that come with llmgw reach the catalog.
|
||||
type PresetSettings struct {
|
||||
// Auto has the leading control plane add a picture model (flux-schnell)
|
||||
// and a 3D model (triposr) by itself, on demand, once a node has a card
|
||||
// that fits one and the catalog has no model that makes the same kind of
|
||||
// thing — so a new cluster's portal has its pictures and 3D pages
|
||||
// without anybody writing a definition. Only where the cluster already
|
||||
// installs ComfyUI (engines.comfyui). A preset somebody removed is not
|
||||
// added again by itself. In force on the leader within a minute.
|
||||
Auto bool `koanf:"auto"`
|
||||
}
|
||||
@@ -81,11 +81,15 @@ type API struct {
|
||||
// revoke records a removed node, so its certificate is refused.
|
||||
revoke func(ctx context.Context, nodeID string, at time.Time) error
|
||||
|
||||
models Models
|
||||
capacity Capacity
|
||||
usage Usage
|
||||
quotas Quotas
|
||||
ctl *control.Controller
|
||||
models Models
|
||||
// presets keeps what became of each preset, presetCfg reads the
|
||||
// settings in force; nil without a store.
|
||||
presets PresetStore
|
||||
presetCfg func() PresetConfig
|
||||
capacity Capacity
|
||||
usage Usage
|
||||
quotas Quotas
|
||||
ctl *control.Controller
|
||||
}
|
||||
|
||||
// New builds the API over a controller.
|
||||
@@ -166,6 +170,7 @@ func (a *API) Register(mux Mux) {
|
||||
}
|
||||
writeJSON(w, http.StatusOK, t)
|
||||
})
|
||||
a.registerPresets(mux)
|
||||
mux.HandleFunc("GET /api/v1/models", a.listModels)
|
||||
mux.HandleFunc("GET /api/v1/replicas", a.listReplicas)
|
||||
// Listing is a read and deleting is a separate verb, so a mistyped
|
||||
@@ -1229,6 +1234,8 @@ func (a *API) removeModel(w http.ResponseWriter, r *http.Request) {
|
||||
writeError(w, http.StatusBadRequest, err.Error())
|
||||
return
|
||||
}
|
||||
// A preset removed is one the leader must not put back by itself.
|
||||
a.presetDeclined(r.Context(), name, actorOf(r))
|
||||
writeJSON(w, http.StatusOK, Removed{Removed: name})
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,353 @@
|
||||
package adminapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/discovery"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/provision"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/settings"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/store"
|
||||
)
|
||||
|
||||
// PresetsView is the models that come with llmgw, and whether the leader adds
|
||||
// them by itself.
|
||||
type PresetsView struct {
|
||||
// Auto is whether a preset is added when a node fits it and the catalog
|
||||
// has no model that makes what it makes (presets.auto).
|
||||
Auto bool `json:"auto"`
|
||||
// ComfyUI is engines.comfyui as it stands: the version the nodes
|
||||
// install, "" for none — in which case adding a preset sets it, and the
|
||||
// control planes start again on that.
|
||||
ComfyUI string `json:"comfyui"`
|
||||
Presets []PresetView `json:"presets"`
|
||||
}
|
||||
|
||||
// PresetView is one preset as it stands in this cluster.
|
||||
type PresetView struct {
|
||||
Name string `json:"name"`
|
||||
Makes string `json:"makes"`
|
||||
Description string `json:"description"`
|
||||
Card string `json:"card"`
|
||||
Licence catalog.License `json:"licence"`
|
||||
// Fits is whether some node has a card that meets the preset's need;
|
||||
// FitsClasses names those classes.
|
||||
Fits bool `json:"fits"`
|
||||
FitsClasses []string `json:"fits_classes,omitempty"`
|
||||
InCatalog bool `json:"in_catalog"`
|
||||
// AddedBy is "auto" when the leader added it, who did otherwise, ""
|
||||
// when it was not added as a preset; AddedAt is when.
|
||||
AddedBy string `json:"added_by,omitempty"`
|
||||
AddedAt time.Time `json:"added_at,omitzero"`
|
||||
// Declined is whether somebody removed it after it was added, so it is
|
||||
// not added again by itself; adding it again clears that.
|
||||
Declined bool `json:"declined"`
|
||||
// Blocked is why the leader does not add it by itself — presets.auto
|
||||
// off, no ComfyUI, no card that fits, declined, another model already
|
||||
// making the same — empty when it would or has.
|
||||
Blocked string `json:"blocked,omitempty"`
|
||||
}
|
||||
|
||||
// PresetsAutoRequest turns the automatic adding of presets on or off.
|
||||
type PresetsAutoRequest struct {
|
||||
On bool `json:"on"`
|
||||
}
|
||||
|
||||
// errPresetsUnavailable is a control plane without the store presets are
|
||||
// kept in.
|
||||
var errPresetsUnavailable = errors.New("this control plane has no store, so presets cannot be added here")
|
||||
|
||||
// PresetStore keeps what became of each preset, and the audit log the
|
||||
// leader writes its own additions to.
|
||||
type PresetStore interface {
|
||||
PresetStates(ctx context.Context) (map[string]store.PresetState, error)
|
||||
PresetAdded(ctx context.Context, name, by string, at time.Time) error
|
||||
PresetDeclined(ctx context.Context, name, by string, at time.Time) error
|
||||
WriteAudit(ctx context.Context, e store.AuditEvent) error
|
||||
}
|
||||
|
||||
// PresetConfig is what the presets read of the settings in force.
|
||||
type PresetConfig struct {
|
||||
// Auto is presets.auto.
|
||||
Auto bool
|
||||
// ComfyUI is engines.comfyui: the version the nodes install, empty for
|
||||
// none.
|
||||
ComfyUI string
|
||||
}
|
||||
|
||||
// SetPresets enables the presets: where what became of them is kept, and
|
||||
// the settings in force.
|
||||
func (a *API) SetPresets(st PresetStore, cfg func() PresetConfig) {
|
||||
a.presets, a.presetCfg = st, cfg
|
||||
}
|
||||
|
||||
// Presets is the presets as they stand in this cluster.
|
||||
func (a *API) Presets(ctx context.Context) (PresetsView, error) {
|
||||
if a.presets == nil || a.presetCfg == nil {
|
||||
return PresetsView{}, errPresetsUnavailable
|
||||
}
|
||||
states, err := a.presets.PresetStates(ctx)
|
||||
if err != nil {
|
||||
return PresetsView{}, err
|
||||
}
|
||||
cfg := a.presetCfg()
|
||||
cat := a.ctl.Catalog()
|
||||
kinds := a.gpuKinds()
|
||||
out := PresetsView{Auto: cfg.Auto, ComfyUI: cfg.ComfyUI}
|
||||
for _, p := range catalog.Presets() {
|
||||
v := PresetView{Name: p.Model.Name, Makes: p.Makes, Description: p.Model.Description,
|
||||
Card: presetCard(p.Model), FitsClasses: presetFits(p.Model, kinds)}
|
||||
if p.Model.License != nil {
|
||||
v.Licence = *p.Model.License
|
||||
}
|
||||
v.Fits = len(v.FitsClasses) > 0
|
||||
_, v.InCatalog = cat.Resolve(p.Model.Name)
|
||||
if st, ok := states[p.Model.Name]; ok {
|
||||
v.AddedBy, v.AddedAt, v.Declined = st.AddedBy, st.AddedAt, st.Declined
|
||||
}
|
||||
v.Blocked = presetBlocked(p, v, cfg, cat)
|
||||
out.Presets = append(out.Presets, v)
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// AddPreset adds the preset of that name, and clears its decline. A cluster
|
||||
// that installs no ComfyUI yet is set to (engines.comfyui), as `llmgw ctl
|
||||
// model add` does; that change starts the control planes again.
|
||||
func (a *API) AddPreset(ctx context.Context, name, by string) error {
|
||||
if a.presets == nil || a.presetCfg == nil || a.models == nil {
|
||||
return errPresetsUnavailable
|
||||
}
|
||||
p, ok := catalog.PresetNamed(name)
|
||||
if !ok {
|
||||
return fmt.Errorf("%w: %q (there are %s)", errNoSuchPreset, name, strings.Join(catalog.PresetNames(), ", "))
|
||||
}
|
||||
if _, in := a.ctl.Catalog().Resolve(name); in {
|
||||
return fmt.Errorf("%s is already in the catalog", name)
|
||||
}
|
||||
if a.presetCfg().ComfyUI == "" {
|
||||
if err := a.setComfyUI(ctx, by); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if err := a.models.Add(ctx, p.Model, by); err != nil {
|
||||
return err
|
||||
}
|
||||
return a.presets.PresetAdded(ctx, name, by, time.Now())
|
||||
}
|
||||
|
||||
// SetAutoPresets turns presets.auto on or off.
|
||||
func (a *API) SetAutoPresets(ctx context.Context, on bool, by string) error {
|
||||
if a.presets == nil {
|
||||
return errPresetsUnavailable
|
||||
}
|
||||
note := "presets added by themselves: " + map[bool]string{true: "on", false: "off"}[on]
|
||||
return a.editSettings(ctx, []string{"presets", "auto"}, strconv.FormatBool(on), by, note)
|
||||
}
|
||||
|
||||
// PresetsPass adds, as "auto", each preset a node fits whose kind of model
|
||||
// the catalog has none of: run by the leader, now and then. It adds nothing
|
||||
// with presets.auto off, where the cluster installs no ComfyUI, or a preset
|
||||
// somebody declined. It says what it added.
|
||||
func (a *API) PresetsPass(ctx context.Context) ([]string, error) {
|
||||
v, err := a.Presets(ctx)
|
||||
if err != nil || !v.Auto {
|
||||
return nil, err
|
||||
}
|
||||
var added []string
|
||||
for _, pv := range v.Presets {
|
||||
if pv.Blocked != "" || pv.InCatalog {
|
||||
continue
|
||||
}
|
||||
p, _ := catalog.PresetNamed(pv.Name)
|
||||
if err := a.models.Add(ctx, p.Model, store.PresetAdder); err != nil {
|
||||
return added, fmt.Errorf("adding %s: %w", pv.Name, err)
|
||||
}
|
||||
now := time.Now()
|
||||
if err := a.presets.PresetAdded(ctx, pv.Name, store.PresetAdder, now); err != nil {
|
||||
return added, err
|
||||
}
|
||||
_ = a.presets.WriteAudit(ctx, store.AuditEvent{At: now, Actor: store.PresetAdder, Source: "presets",
|
||||
Action: "add preset", Target: pv.Name, Status: http.StatusOK,
|
||||
Detail: fmt.Sprintf("%s, on demand: a node has %s (%s) and the catalog made no %s",
|
||||
pv.Name, strings.Join(pv.FitsClasses, ", "), pv.Card, pv.Makes)})
|
||||
added = append(added, pv.Name)
|
||||
}
|
||||
return added, nil
|
||||
}
|
||||
|
||||
// presetDeclined records a preset's name removed from the catalog, so the
|
||||
// leader does not put it back.
|
||||
func (a *API) presetDeclined(ctx context.Context, name, by string) {
|
||||
if a.presets == nil {
|
||||
return
|
||||
}
|
||||
if _, ok := catalog.PresetNamed(name); ok {
|
||||
_ = a.presets.PresetDeclined(ctx, name, by, time.Now())
|
||||
}
|
||||
}
|
||||
|
||||
// presetBlocked is why the leader would not add a preset by itself, empty
|
||||
// when it would (or has).
|
||||
func presetBlocked(p catalog.Preset, v PresetView, cfg PresetConfig, cat *catalog.Catalog) string {
|
||||
switch {
|
||||
case v.InCatalog:
|
||||
return ""
|
||||
case v.Declined:
|
||||
return "removed from the catalog after it was added; add it again to undo"
|
||||
case !cfg.Auto:
|
||||
return "presets.auto is off"
|
||||
case cfg.ComfyUI == "":
|
||||
return "the cluster installs no ComfyUI (engines.comfyui); adding it by hand sets that"
|
||||
case !v.Fits:
|
||||
return "no node has a card it needs (" + v.Card + ")"
|
||||
}
|
||||
for _, m := range cat.Models() {
|
||||
if p.Makes == catalog.OutputPictures && m.MakesImages() || p.Makes == catalog.OutputMeshes && m.MakesMeshes() {
|
||||
return "the catalog has " + m.Name + ", which makes " + p.Makes + " already"
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// presetCard is what a preset needs of a card, as people read it.
|
||||
func presetCard(m catalog.Model) string {
|
||||
var needs []string
|
||||
for _, pr := range m.Profiles {
|
||||
switch {
|
||||
case pr.GPU != nil:
|
||||
needs = append(needs, pr.GPU.String())
|
||||
case pr.GPUClass != "":
|
||||
needs = append(needs, pr.GPUClass)
|
||||
}
|
||||
}
|
||||
return strings.Join(needs, " or ")
|
||||
}
|
||||
|
||||
// presetFits are the classes of card in the cluster one of the preset's
|
||||
// profiles can run on.
|
||||
func presetFits(m catalog.Model, kinds []catalog.GPUKind) []string {
|
||||
var out []string
|
||||
for _, k := range kinds {
|
||||
for _, pr := range m.Profiles {
|
||||
if pr.GPU != nil && pr.GPU.Fits(k) || pr.GPU == nil && pr.GPUClass == k.Class {
|
||||
out = append(out, k.Class)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// gpuKinds are the kinds of card the cluster's nodes have.
|
||||
func (a *API) gpuKinds() []catalog.GPUKind {
|
||||
var gpus []discovery.GPU
|
||||
for _, n := range a.ctl.Nodes() {
|
||||
gpus = append(gpus, n.GPUs...)
|
||||
}
|
||||
return catalog.GPUKinds(gpus)
|
||||
}
|
||||
|
||||
// setComfyUI has the nodes install the ComfyUI this release knows.
|
||||
func (a *API) setComfyUI(ctx context.Context, by string) error {
|
||||
if a.settings != nil {
|
||||
cur, err := a.settings.Store.ClusterSettings(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if doc, err := settings.FromBytes("settings", []byte(cur.Body)); err == nil {
|
||||
if n := doc.Node([]string{"engines", catalog.EngineComfyUI}); n != nil && n.Value == "" {
|
||||
return errors.New("engines.comfyui is set to none, so the nodes install no ComfyUI: " +
|
||||
"set a version (llmgw ctl config set engines.comfyui " + provision.ComfyUIVersion() + ")")
|
||||
}
|
||||
}
|
||||
}
|
||||
return a.editSettings(ctx, []string{"engines", catalog.EngineComfyUI}, provision.ComfyUIVersion(), by,
|
||||
"ComfyUI for the presets")
|
||||
}
|
||||
|
||||
// editSettings sets one key of the cluster's settings, as a new version.
|
||||
func (a *API) editSettings(ctx context.Context, path []string, value, by, note string) error {
|
||||
if a.settings == nil {
|
||||
return errors.New("this control plane keeps no cluster settings")
|
||||
}
|
||||
cur, err := a.settings.Store.ClusterSettings(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
doc, err := settings.FromBytes("settings", []byte(cur.Body))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if n := doc.Node(path); n != nil && n.Value == value {
|
||||
return nil
|
||||
}
|
||||
if err := doc.SetYAML(path, value); err != nil {
|
||||
return err
|
||||
}
|
||||
b, err := doc.Bytes()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if err := a.settings.Check(b); err != nil {
|
||||
return err
|
||||
}
|
||||
_, err = a.settings.Store.PutClusterSettings(ctx, cur.Version, string(b), by, note)
|
||||
return err
|
||||
}
|
||||
|
||||
func (a *API) registerPresets(mux Mux) {
|
||||
mux.HandleFunc("GET /api/v1/presets", func(w http.ResponseWriter, r *http.Request) {
|
||||
v, err := a.Presets(r.Context())
|
||||
if err != nil {
|
||||
writeError(w, presetStatus(err), err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, v)
|
||||
})
|
||||
mux.HandleFunc("POST /api/v1/presets/{name}", func(w http.ResponseWriter, r *http.Request) {
|
||||
if err := a.AddPreset(r.Context(), r.PathValue("name"), actorOf(r)); err != nil {
|
||||
writeError(w, presetStatus(err), err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, ModelAdded{Added: r.PathValue("name")})
|
||||
})
|
||||
mux.HandleFunc("PUT /api/v1/presets/auto", func(w http.ResponseWriter, r *http.Request) {
|
||||
var req PresetsAutoRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
writeError(w, http.StatusBadRequest, err.Error())
|
||||
return
|
||||
}
|
||||
if err := a.SetAutoPresets(r.Context(), req.On, actorOf(r)); err != nil {
|
||||
writeError(w, presetStatus(err), err.Error())
|
||||
return
|
||||
}
|
||||
v, err := a.Presets(r.Context())
|
||||
if err != nil {
|
||||
writeError(w, presetStatus(err), err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, v)
|
||||
})
|
||||
}
|
||||
|
||||
// errNoSuchPreset is a name no preset has.
|
||||
var errNoSuchPreset = errors.New("no preset of that name")
|
||||
|
||||
func presetStatus(err error) int {
|
||||
switch {
|
||||
case errors.Is(err, errPresetsUnavailable):
|
||||
return http.StatusNotImplemented
|
||||
case errors.Is(err, errNoSuchPreset):
|
||||
return http.StatusNotFound
|
||||
default:
|
||||
return http.StatusBadRequest
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,141 @@
|
||||
package adminapi
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/discovery"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/inventory"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/store"
|
||||
)
|
||||
|
||||
func v100Node(id string) inventory.Node {
|
||||
return inventory.Node{ID: id, State: inventory.Ready, AgentVersion: "v1", GPUs: []discovery.GPU{{
|
||||
Index: 0, Name: "Tesla V100-SXM2-32GB", MemoryTotalMB: 32768, ComputeCapability: "7.0"}}}
|
||||
}
|
||||
|
||||
func presetsAPI(t *testing.T, models []catalog.Model, cfg PresetConfig, nodes ...inventory.Node) (*API, *fakeModels, *store.DB) {
|
||||
t.Helper()
|
||||
a, _ := setup(t, models, nodes...)
|
||||
st, err := store.OpenSQLite(t.Context(), filepath.Join(t.TempDir(), "p.db"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Cleanup(func() { _ = st.Close() })
|
||||
fm := &fakeModels{}
|
||||
a.SetModels(fm)
|
||||
a.SetPresets(st, func() PresetConfig { return cfg })
|
||||
a.SetSettings(&Settings{Store: st, Check: func([]byte) error { return nil }})
|
||||
return a, fm, st
|
||||
}
|
||||
|
||||
func TestTheLeaderAddsThePresetsANodeFitsAndNoOtherWhere(t *testing.T) {
|
||||
// A customer's portal had no pictures or 3D pages: nobody had written a
|
||||
// definition for either, on a cluster with a V100 that runs both.
|
||||
a, fm, st := presetsAPI(t, testModels(), PresetConfig{Auto: true, ComfyUI: "0.39.2"}, v100Node("p-g3"))
|
||||
added, err := a.PresetsPass(t.Context())
|
||||
if err != nil || !slices.Equal(added, []string{"flux-schnell", "triposr"}) {
|
||||
t.Fatalf("added %v %v", added, err)
|
||||
}
|
||||
if !slices.Equal(fm.actors, []string{store.PresetAdder, store.PresetAdder}) {
|
||||
t.Errorf("added by %v", fm.actors)
|
||||
}
|
||||
states, _ := st.PresetStates(t.Context())
|
||||
if states["triposr"].AddedBy != store.PresetAdder || states["triposr"].AddedAt.IsZero() {
|
||||
t.Errorf("state %+v", states["triposr"])
|
||||
}
|
||||
events, _ := st.AuditEvents(t.Context(), store.AuditFilter{Limit: 10})
|
||||
if len(events) != 2 || events[0].Actor != store.PresetAdder || !strings.Contains(events[0].Detail, "v100-32g") {
|
||||
t.Errorf("audit %+v", events)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPresetIsNotAddedByItselfWhereItShouldNotBe(t *testing.T) {
|
||||
picture := catalog.Model{Name: "sdxl", Source: "/w/sdxl.safetensors", ComfyUI: &catalog.ComfyUI{Workflow: "flux-schnell"},
|
||||
Profiles: []catalog.Profile{{Name: "p", Engine: catalog.EngineComfyUI, GPUClass: "v100-32g", TP: 1}}}
|
||||
cases := []struct {
|
||||
name string
|
||||
models []catalog.Model
|
||||
cfg PresetConfig
|
||||
nodes []inventory.Node
|
||||
want map[string]string // preset -> part of why it is not added
|
||||
}{
|
||||
{"auto off", testModels(), PresetConfig{Auto: false, ComfyUI: "0.39.2"}, []inventory.Node{v100Node("g")},
|
||||
map[string]string{"flux-schnell": "presets.auto is off", "triposr": "presets.auto is off"}},
|
||||
{"no ComfyUI", testModels(), PresetConfig{Auto: true}, []inventory.Node{v100Node("g")},
|
||||
map[string]string{"triposr": "engines.comfyui"}},
|
||||
{"no card", testModels(), PresetConfig{Auto: true, ComfyUI: "0.39.2"}, nil,
|
||||
map[string]string{"triposr": "no node has a card"}},
|
||||
{"a picture model already", append(testModels(), picture), PresetConfig{Auto: true, ComfyUI: "0.39.2"},
|
||||
[]inventory.Node{v100Node("g")}, map[string]string{"flux-schnell": "sdxl"}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
a, fm, _ := presetsAPI(t, c.models, c.cfg, c.nodes...)
|
||||
v, err := a.Presets(t.Context())
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if v.ComfyUI != c.cfg.ComfyUI {
|
||||
t.Errorf("comfyui %q", v.ComfyUI)
|
||||
}
|
||||
for _, p := range v.Presets {
|
||||
if why, ok := c.want[p.Name]; ok && !strings.Contains(p.Blocked, why) {
|
||||
t.Errorf("%s blocked %q, want it to say %q", p.Name, p.Blocked, why)
|
||||
}
|
||||
}
|
||||
_, _ = a.PresetsPass(t.Context())
|
||||
for _, m := range fm.added {
|
||||
if _, blocked := c.want[m.Name]; blocked {
|
||||
t.Errorf("%s was added", m.Name)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPresetRemovedStaysOutUntilAddedAgain(t *testing.T) {
|
||||
a, fm, _ := presetsAPI(t, testModels(), PresetConfig{Auto: true, ComfyUI: "0.39.2"}, v100Node("g"))
|
||||
if code := call(t, a, http.MethodDelete, "/api/v1/models/triposr", "", nil); code != http.StatusOK {
|
||||
t.Fatalf("remove %d", code)
|
||||
}
|
||||
var v PresetsView
|
||||
call(t, a, http.MethodGet, "/api/v1/presets", "", &v)
|
||||
i := slices.IndexFunc(v.Presets, func(p PresetView) bool { return p.Name == "triposr" })
|
||||
if i < 0 || !v.Presets[i].Declined || !strings.Contains(v.Presets[i].Blocked, "removed") {
|
||||
t.Fatalf("after removal %+v", v.Presets)
|
||||
}
|
||||
added, _ := a.PresetsPass(t.Context())
|
||||
if slices.Contains(added, "triposr") {
|
||||
t.Error("a removed preset was added back by itself")
|
||||
}
|
||||
if code := call(t, a, http.MethodPost, "/api/v1/presets/triposr", "", nil); code != http.StatusOK {
|
||||
t.Fatalf("add again %d", code)
|
||||
}
|
||||
if fm.added[len(fm.added)-1].Name != "triposr" {
|
||||
t.Error("adding it again did not add it")
|
||||
}
|
||||
call(t, a, http.MethodGet, "/api/v1/presets", "", &v)
|
||||
i = slices.IndexFunc(v.Presets, func(p PresetView) bool { return p.Name == "triposr" })
|
||||
if v.Presets[i].Declined {
|
||||
t.Error("adding it again left it declined")
|
||||
}
|
||||
if code := call(t, a, http.MethodPost, "/api/v1/presets/nope", "", nil); code != http.StatusNotFound {
|
||||
t.Errorf("unknown preset %d", code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPresetsAutoIsTheClusterSetting(t *testing.T) {
|
||||
a, _, st := presetsAPI(t, testModels(), PresetConfig{Auto: true, ComfyUI: "0.39.2"})
|
||||
if code := call(t, a, http.MethodPut, "/api/v1/presets/auto", `{"on":false}`, nil); code != http.StatusOK {
|
||||
t.Fatalf("put %d", code)
|
||||
}
|
||||
cur, _ := st.ClusterSettings(t.Context())
|
||||
if !strings.Contains(cur.Body, "auto: false") {
|
||||
t.Errorf("settings %q", cur.Body)
|
||||
}
|
||||
}
|
||||
@@ -42,6 +42,13 @@ type Route struct {
|
||||
Status int
|
||||
// CSV is set when the answer is CSV unless JSON is asked for.
|
||||
CSV bool
|
||||
// Form is a request sent as multipart/form-data — a file uploaded —
|
||||
// whose fields are Request's.
|
||||
Form bool
|
||||
// Stream is an answer that may come as server-sent events instead.
|
||||
Stream bool
|
||||
// Binary is the type of an answer that is a file, not JSON.
|
||||
Binary string
|
||||
}
|
||||
|
||||
// Param is a query parameter.
|
||||
@@ -58,6 +65,7 @@ type Param struct {
|
||||
// before them and their name.
|
||||
var PathParams = map[string]string{
|
||||
"models/{name}": "The model's name in the catalog.",
|
||||
"presets/{name}": "The preset's name, as `llmgw ctl model presets` lists it.",
|
||||
"nodes/{id}": "The node's ID, as `llmgw ctl nodes` lists it.",
|
||||
"jobs/{id}": "The job's ID, as starting it answered.",
|
||||
"runs/{id}": "The quality run's ID, as starting it answered.",
|
||||
@@ -129,6 +137,12 @@ var Routes = []Route{
|
||||
Request: CollectRequest{}, OptionalBody: true, Response: []CollectResult{}},
|
||||
|
||||
// The catalog.
|
||||
{Method: "GET", Path: "/api/v1/presets", Summary: "The models that come with llmgw: whether each fits this cluster, is in the catalog, was declined",
|
||||
Response: PresetsView{}},
|
||||
{Method: "POST", Path: "/api/v1/presets/{name}", Summary: "Add a preset to the catalog, and clear its decline",
|
||||
Response: ModelAdded{}},
|
||||
{Method: "PUT", Path: "/api/v1/presets/auto", Summary: "Turn on or off the adding of presets when a node fits them",
|
||||
Request: PresetsAutoRequest{}, Response: PresetsView{}},
|
||||
{Method: "GET", Path: "/api/v1/models", Summary: "Every model, with its replicas and state",
|
||||
Response: []ModelView{}},
|
||||
{Method: "POST", Path: "/api/v1/models", Summary: "Add a model to the catalog",
|
||||
|
||||
@@ -279,6 +279,14 @@ type Profile struct {
|
||||
// which the router's hashing assumes; arguments overriding either leave
|
||||
// the index empty, and the agent says so in its log.
|
||||
KVEvents bool `json:"kv_events,omitempty" koanf:"kv_events"`
|
||||
|
||||
// GPU says what card the profile needs, in place of naming its class:
|
||||
// it stands for every class in the cluster that meets it. A catalog
|
||||
// entry written once then places sensibly on any site's cards.
|
||||
GPU *GPUNeed `json:"gpu,omitempty" koanf:"gpu"`
|
||||
// ComfyUI is this profile's own workflow, checkpoint and nodes, over the
|
||||
// model's: an fp8 workflow where the card has fp8, fp16 where it has not.
|
||||
ComfyUI *ProfileComfyUI `json:"comfyui,omitempty" koanf:"comfyui"`
|
||||
}
|
||||
|
||||
// CPUOnly reports whether this profile needs no GPUs.
|
||||
@@ -287,7 +295,7 @@ type Profile struct {
|
||||
// actually serve without a card are allowed to leave it out — otherwise an
|
||||
// omitted class would quietly become a replica placed on a machine with no
|
||||
// hardware to run it.
|
||||
func (p Profile) CPUOnly() bool { return p.GPUClass == "" && cpuCapable(p.Engine) }
|
||||
func (p Profile) CPUOnly() bool { return p.GPUClass == "" && p.GPU == nil && cpuCapable(p.Engine) }
|
||||
|
||||
// cpuCapable reports whether an engine can serve a model without a GPU.
|
||||
//
|
||||
@@ -401,6 +409,10 @@ type Model struct {
|
||||
// say that the repository has published different weights since, and
|
||||
// move the model to them.
|
||||
Origin *Origin `json:"origin,omitempty" koanf:"origin"`
|
||||
|
||||
// Shared is set on an environment's hidden entry only: the members its
|
||||
// replica answers for. Made by the catalog, never written.
|
||||
Shared *SharedComfy `json:"shared,omitempty" koanf:"-"`
|
||||
}
|
||||
|
||||
// RoleGuard is a judge model's role.
|
||||
@@ -518,12 +530,53 @@ func (m Model) MakesMeshes() bool {
|
||||
// License is the terms what a model makes comes under: said beside every
|
||||
// result, and written into a mesh, which travels without the API.
|
||||
type License struct {
|
||||
// ID names the licence for a machine: an SPDX identifier where there is
|
||||
// one (MIT, Apache-2.0, CC-BY-NC-4.0), else a lowercase name of the
|
||||
// licence's own (stability-community, tencent-hunyuan-community). What a
|
||||
// person's or a site's choice of licences matches on. Name is for people.
|
||||
ID string `json:"id,omitempty" koanf:"id"`
|
||||
// Name is the licence's own: MIT, Apache-2.0.
|
||||
Name string `json:"name" koanf:"name"`
|
||||
URL string `json:"url,omitempty" koanf:"url"`
|
||||
// Notice is what must accompany what was made: attribution, terms on
|
||||
// the output, what the weights were trained on.
|
||||
Notice string `json:"notice,omitempty" koanf:"notice"`
|
||||
// Commercial says whether what is made may be used commercially: nil
|
||||
// is not said, which is not the same as yes.
|
||||
Commercial *bool `json:"commercial,omitempty" koanf:"commercial"`
|
||||
// ExcludedRegions are where the licence grants nothing: ISO 3166 codes,
|
||||
// and EU for the union (Hunyuan's: EU, UK, KR).
|
||||
ExcludedRegions []string `json:"excluded_regions,omitempty" koanf:"excluded_regions"`
|
||||
// RevenueCapUSD is the yearly revenue above which the licence asks for
|
||||
// another agreement (Stability's community licence: 1000000). Zero is
|
||||
// none.
|
||||
RevenueCapUSD int64 `json:"revenue_cap_usd,omitempty" koanf:"revenue_cap_usd"`
|
||||
// Attribution is what a product using the output must show: "Powered by
|
||||
// Stability AI".
|
||||
Attribution string `json:"attribution,omitempty" koanf:"attribution"`
|
||||
}
|
||||
|
||||
var (
|
||||
licenseID = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9.+-]{0,63}$`)
|
||||
regionID = regexp.MustCompile(`^[A-Z]{2}$`)
|
||||
)
|
||||
|
||||
func (l License) validate(model string) error {
|
||||
if strings.TrimSpace(l.Name) == "" {
|
||||
return fmt.Errorf("model %q: license.name is required: a licence nobody can name is none", model)
|
||||
}
|
||||
if l.ID != "" && !licenseID.MatchString(l.ID) {
|
||||
return fmt.Errorf("model %q: license.id %q is not an SPDX-style identifier (letters, digits, '.', '+', '-')", model, l.ID)
|
||||
}
|
||||
for _, r := range l.ExcludedRegions {
|
||||
if !regionID.MatchString(r) {
|
||||
return fmt.Errorf("model %q: license.excluded_regions %q is not an ISO 3166 code in capitals (EU for the union)", model, r)
|
||||
}
|
||||
}
|
||||
if l.RevenueCapUSD < 0 {
|
||||
return fmt.Errorf("model %q: license.revenue_cap_usd is negative", model)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// EngineComfyUI is the engine that runs ComfyUI on a node.
|
||||
@@ -549,12 +602,27 @@ type ComfyUI struct {
|
||||
// must.
|
||||
Checkpoint string `json:"checkpoint,omitempty" koanf:"checkpoint"`
|
||||
// Output is what the workflow makes: pictures (the default), asked for
|
||||
// at /v1/images/generations, or meshes, asked for as a job at
|
||||
// /v1/3d/generations from a picture.
|
||||
// at /v1/images/generations; meshes, asked for as a job at
|
||||
// /v1/3d/generations from a picture; or video, audio or files. Every
|
||||
// kind is asked for as a job at /v1/workflows/runs too.
|
||||
Output string `json:"output,omitempty" koanf:"output"`
|
||||
// Inputs are what the workflow takes from a request at
|
||||
// /v1/workflows/runs, each the placeholder of its name.
|
||||
Inputs []Input `json:"inputs,omitempty" koanf:"inputs"`
|
||||
// Nodes are custom nodes the workflow needs, put in each replica's own
|
||||
// custom_nodes at the commit named.
|
||||
Nodes []CustomNode `json:"nodes,omitempty" koanf:"nodes"`
|
||||
// HuggingFaceRepo is the repository a custom node loads the weights by
|
||||
// name from (Stable Fast 3D's loader asks for stabilityai/stable-fast-3d):
|
||||
// the replica's weights are shown to the node there, in the Hugging Face
|
||||
// cache of the engines' user, so nothing is fetched and no token is
|
||||
// needed when it runs.
|
||||
HuggingFaceRepo string `json:"huggingface_repo,omitempty" koanf:"huggingface_repo"`
|
||||
// Environment names the models that may share one ComfyUI replica: every
|
||||
// model of an environment agrees on the custom nodes they both name, so
|
||||
// one replica can carry all of them and ComfyUI moves between their
|
||||
// weights itself. Empty is an environment of the model alone.
|
||||
Environment string `json:"environment,omitempty" koanf:"environment"`
|
||||
}
|
||||
|
||||
// CustomNode is a ComfyUI node from a git repository.
|
||||
@@ -570,12 +638,29 @@ type CustomNode struct {
|
||||
// every other one at the version ComfyUI already runs. One named here
|
||||
// is first on ComfyUI's path, so its range must suit ComfyUI too.
|
||||
Requirements []string `json:"requirements,omitempty" koanf:"requirements"`
|
||||
// Build are directories of the repository that are Python packages to
|
||||
// be compiled rather than downloaded: C++ and CUDA extensions no index
|
||||
// has (Stable Fast 3D's texture_baker and uv_unwrapper). Each is built
|
||||
// as a wheel with ComfyUI's Python for the card the replica runs on,
|
||||
// kept on the node for the next replica on the same kind of card, and
|
||||
// installed beside the replica like its requirements.
|
||||
Build []string `json:"build,omitempty" koanf:"build"`
|
||||
}
|
||||
|
||||
// NodesEnv carries a ComfyUI model's custom nodes to the agent, which hands
|
||||
// them to the gate.
|
||||
const NodesEnv = "LLMGW_COMFYUI_NODES"
|
||||
|
||||
// HFRepoEnv carries the repository a node loads the weights by name from.
|
||||
const HFRepoEnv = "LLMGW_COMFYUI_HF_REPO"
|
||||
|
||||
// SharedModelsEnv carries a shared replica's members — name, weights source,
|
||||
// repository — to the agent, which fetches each and hands the gate where
|
||||
// they landed.
|
||||
const SharedModelsEnv = "LLMGW_COMFYUI_MODELS"
|
||||
|
||||
var hfRepo = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]*/[A-Za-z0-9][A-Za-z0-9._-]*$`)
|
||||
|
||||
var (
|
||||
fullCommit = regexp.MustCompile(`^[0-9a-f]{40}$`)
|
||||
packageSpec = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]*(\[[A-Za-z0-9,._-]+\])?\s*([<>=!~]=?\s*[A-Za-z0-9.*+!_-]+\s*,?\s*)*$`)
|
||||
@@ -590,6 +675,12 @@ func (n CustomNode) validate(model string) error {
|
||||
return fmt.Errorf("model %q: custom node %s needs its full commit (40 hex), not %q: a branch moves",
|
||||
model, n.Repo, n.Commit)
|
||||
}
|
||||
for _, b := range n.Build {
|
||||
clean := path.Clean(b)
|
||||
if b == "" || path.IsAbs(b) || clean == "." || clean == ".." || strings.HasPrefix(clean, "../") || strings.ContainsAny(b, "\\ ") {
|
||||
return fmt.Errorf("model %q: custom node %s build %q is not a directory inside the repository", model, n.Repo, b)
|
||||
}
|
||||
}
|
||||
for _, r := range n.Requirements {
|
||||
// A package and a version range: an option or a URL would install
|
||||
// from somewhere other than PyPI.
|
||||
@@ -659,11 +750,17 @@ func (m Model) validateComfyUI() error {
|
||||
}
|
||||
}
|
||||
}
|
||||
if out := m.comfyOutput(); out != OutputPictures && out != OutputMeshes {
|
||||
return fmt.Errorf("model %q: comfyui.output %q is not pictures or meshes", m.Name, out)
|
||||
if err := validOutput(m.Name, m.comfyOutput()); err != nil {
|
||||
return err
|
||||
}
|
||||
if m.comfyOutput() == OutputMeshes && w == "" {
|
||||
return fmt.Errorf("model %q: a model that makes meshes names its workflow: no built-in makes them", m.Name)
|
||||
if m.ComfyUI != nil && m.ComfyUI.HuggingFaceRepo != "" && !hfRepo.MatchString(m.ComfyUI.HuggingFaceRepo) {
|
||||
return fmt.Errorf("model %q: comfyui.huggingface_repo %q is not owner/name", m.Name, m.ComfyUI.HuggingFaceRepo)
|
||||
}
|
||||
if out := m.comfyOutput(); out != OutputPictures && w == "" {
|
||||
return fmt.Errorf("model %q: a model that makes %s names its workflow: no built-in makes them", m.Name, out)
|
||||
}
|
||||
if err := validateInputs(m.Name, m.ComfyInputs()); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, ckpt := m.ComfyWorkflow(); ckpt == "" {
|
||||
return fmt.Errorf("model %q: its source is a set of files, so comfyui.checkpoint must name the one the workflow loads",
|
||||
@@ -690,6 +787,9 @@ func New(models []Model) (*Catalog, error) {
|
||||
}
|
||||
|
||||
for i := range models {
|
||||
if models[i].IsEnvironment() {
|
||||
continue // the catalog's own, made again below
|
||||
}
|
||||
m := models[i].normalize()
|
||||
if err := m.validate(); err != nil {
|
||||
return nil, err
|
||||
@@ -763,6 +863,25 @@ func New(models []Model) (*Catalog, error) {
|
||||
}
|
||||
canaryOf[target.Name] = name
|
||||
}
|
||||
envs, err := c.environments()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for _, e := range envs {
|
||||
if len(e.Models) < 2 {
|
||||
continue
|
||||
}
|
||||
var members []Model
|
||||
for _, n := range e.Models {
|
||||
members = append(members, c.models[n])
|
||||
}
|
||||
em := envModel(e, members)
|
||||
if _, clash := c.models[em.Name]; clash {
|
||||
return nil, fmt.Errorf("model %q: the name is the hidden entry of environment %q", em.Name, e.Name)
|
||||
}
|
||||
c.models[em.Name] = em
|
||||
c.order = append(c.order, em.Name)
|
||||
}
|
||||
return c, nil
|
||||
}
|
||||
|
||||
@@ -897,6 +1016,11 @@ func (m Model) validate() error {
|
||||
if m.Source == "" {
|
||||
return fmt.Errorf("model %q: source is required", m.Name)
|
||||
}
|
||||
if m.License != nil {
|
||||
if err := m.License.validate(m.Name); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
// A page, not weights: a node fetches the HTML as one file and the
|
||||
// engine fails at start, on a path that looks right. For vLLM it was
|
||||
// read as the repository id when the model was made; only a source
|
||||
@@ -1011,10 +1135,18 @@ func (m Model) validate() error {
|
||||
return fmt.Errorf("model %q profile %q: keep_within: %w", m.Name, p.Name, err)
|
||||
}
|
||||
}
|
||||
if p.GPUClass == "" && !cpuCapable(p.Engine) {
|
||||
return fmt.Errorf("model %q profile %q: gpu_class is required for engine %q",
|
||||
if err := p.validateHardware(m); err != nil {
|
||||
return err
|
||||
}
|
||||
if p.GPUClass == "" && p.GPU == nil && !cpuCapable(p.Engine) {
|
||||
return fmt.Errorf("model %q profile %q: gpu_class is required for engine %q, or gpu: the card it needs",
|
||||
m.Name, p.Name, p.Engine)
|
||||
}
|
||||
if p.GPU != nil {
|
||||
// Its class is known only when it is placed; what can be checked
|
||||
// of a class waits for then.
|
||||
continue
|
||||
}
|
||||
if p.CPUOnly() {
|
||||
if p.Nodes > 1 {
|
||||
return fmt.Errorf("model %q profile %q: a CPU profile cannot span %d nodes",
|
||||
@@ -1125,10 +1257,16 @@ func (c *Catalog) AliasesOf(name string) []string {
|
||||
return slices.Clone(m.Aliases)
|
||||
}
|
||||
|
||||
// PlacementProfiles converts a model's profiles into placement's view.
|
||||
// PlacementProfiles converts a model's profiles into placement's view. A
|
||||
// profile that names its card by need is left out: with no class it would
|
||||
// read to placement as one that needs no GPU. PlacementProfilesFor gives
|
||||
// it the classes it stands for.
|
||||
func (m Model) PlacementProfiles() []placement.Profile {
|
||||
out := make([]placement.Profile, 0, len(m.Profiles))
|
||||
for _, p := range m.Profiles {
|
||||
if p.GPU != nil {
|
||||
continue
|
||||
}
|
||||
out = append(out, placement.Profile{
|
||||
Name: p.Name,
|
||||
Engine: p.Engine,
|
||||
@@ -1177,19 +1315,42 @@ func (m Model) WeightSources() []string {
|
||||
|
||||
// EngineProfile converts a catalog profile into the engine adapter's view.
|
||||
func (m Model) EngineProfile(name string) (engines.Profile, bool) {
|
||||
for _, p := range m.Profiles {
|
||||
if p.Name != name {
|
||||
continue
|
||||
}
|
||||
if p, ok := m.ProfileByName(name); ok {
|
||||
env := p.Env
|
||||
if p.Engine == EngineComfyUI && m.ComfyUI != nil && len(m.ComfyUI.Nodes) > 0 {
|
||||
nodes, _ := json.Marshal(m.ComfyUI.Nodes)
|
||||
env = maps.Clone(p.Env)
|
||||
if nodes := m.ComfyNodesFor(p); p.Engine == EngineComfyUI && len(nodes) > 0 {
|
||||
nodes, _ := json.Marshal(nodes)
|
||||
env = maps.Clone(env)
|
||||
if env == nil {
|
||||
env = map[string]string{}
|
||||
}
|
||||
env[NodesEnv] = string(nodes)
|
||||
}
|
||||
if p.Engine == EngineComfyUI && m.Shared != nil {
|
||||
// Every member's weights, for the node to fetch and the gate to
|
||||
// link: one replica answers for all of them.
|
||||
type member struct {
|
||||
Name string `json:"name"`
|
||||
Source string `json:"source"`
|
||||
HFRepo string `json:"hf_repo,omitempty"`
|
||||
}
|
||||
var ms []member
|
||||
for _, sm := range m.Shared.Members {
|
||||
ms = append(ms, member{Name: sm.Name, Source: sm.Source, HFRepo: sm.HFRepo})
|
||||
}
|
||||
b, _ := json.Marshal(ms)
|
||||
env = maps.Clone(env)
|
||||
if env == nil {
|
||||
env = map[string]string{}
|
||||
}
|
||||
env[SharedModelsEnv] = string(b)
|
||||
}
|
||||
if p.Engine == EngineComfyUI && m.ComfyUI != nil && m.ComfyUI.HuggingFaceRepo != "" {
|
||||
env = maps.Clone(env)
|
||||
if env == nil {
|
||||
env = map[string]string{}
|
||||
}
|
||||
env[HFRepoEnv] = m.ComfyUI.HuggingFaceRepo
|
||||
}
|
||||
return engines.Profile{
|
||||
Name: p.Name,
|
||||
Engine: p.Engine,
|
||||
@@ -1221,13 +1382,23 @@ func (m Model) KVIndex() bool {
|
||||
return false
|
||||
}
|
||||
|
||||
// ProfileByName returns one of a model's profiles.
|
||||
// ProfileByName returns one of a model's profiles, or one a profile that
|
||||
// names its GPU by need stands for: "<profile>@<class>", with the class.
|
||||
func (m Model) ProfileByName(name string) (Profile, bool) {
|
||||
for _, p := range m.Profiles {
|
||||
if p.Name == name {
|
||||
return p, true
|
||||
}
|
||||
}
|
||||
base, class, ok := strings.Cut(name, "@")
|
||||
if !ok || class == "" {
|
||||
return Profile{}, false
|
||||
}
|
||||
for _, p := range m.Profiles {
|
||||
if p.Name == base && p.GPU != nil {
|
||||
return p.forClass(class), true
|
||||
}
|
||||
}
|
||||
return Profile{}, false
|
||||
}
|
||||
|
||||
@@ -1409,11 +1580,13 @@ func (e *External) validate(model string, profiles int) error {
|
||||
if err := checkWorkflow(model, e.Workflow); err != nil {
|
||||
return err
|
||||
}
|
||||
if e.Output != "" && e.Output != OutputPictures && e.Output != OutputMeshes {
|
||||
return fmt.Errorf("model %q: external output %q is not pictures or meshes", model, e.Output)
|
||||
if e.Output != "" {
|
||||
if err := validOutput(model, e.Output); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if e.Output == OutputMeshes && e.Workflow == "" {
|
||||
return fmt.Errorf("model %q: a model that makes meshes names its workflow: no built-in makes them", model)
|
||||
if e.Output != "" && e.Output != OutputPictures && e.Workflow == "" {
|
||||
return fmt.Errorf("model %q: a model that makes %s names its workflow: no built-in makes them", model, e.Output)
|
||||
}
|
||||
default:
|
||||
return fmt.Errorf("model %q: external api %q is not openai or comfyui", model, e.API)
|
||||
|
||||
@@ -0,0 +1,172 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"regexp"
|
||||
"slices"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Environments: the ComfyUI models that may share one replica.
|
||||
//
|
||||
// Every ComfyUI model used to run in a replica of its own, so two models on
|
||||
// one card took turns with a cold start each time: flux, then a mesh model,
|
||||
// then flux again, each loading ComfyUI and its weights from nothing. ComfyUI
|
||||
// itself moves between models' weights in one process; what keeps two models
|
||||
// out of one process is their custom nodes, which share one Python. An
|
||||
// environment is a set of models whose nodes can: the catalog checks it, and
|
||||
// placement may then run one replica for all of them.
|
||||
|
||||
// Environment is one environment's models and what a replica of it carries.
|
||||
type Environment struct {
|
||||
Name string `json:"name"`
|
||||
// Models are the catalog models in it, in catalog order.
|
||||
Models []string `json:"models"`
|
||||
// Nodes are every custom node any of them names, once each.
|
||||
Nodes []CustomNode `json:"nodes,omitempty"`
|
||||
// Sources are every weights source its models load, once each: what a
|
||||
// replica of it must have on its node.
|
||||
Sources []string `json:"sources,omitempty"`
|
||||
}
|
||||
|
||||
// ComfyEnvironment is the environment a ComfyUI model is in, or "" for one in
|
||||
// none, which is an environment of its own.
|
||||
func (m Model) ComfyEnvironment() string {
|
||||
if m.ComfyUI == nil {
|
||||
return ""
|
||||
}
|
||||
return m.ComfyUI.Environment
|
||||
}
|
||||
|
||||
var envName = regexp.MustCompile(`^[a-z0-9][a-z0-9._-]{0,62}$`)
|
||||
|
||||
// Environments are the catalog's named environments, by name.
|
||||
func (c *Catalog) Environments() []Environment {
|
||||
envs, _ := c.environments()
|
||||
return envs
|
||||
}
|
||||
|
||||
// EnvironmentOf is the environment a model is in, when it is in a named one.
|
||||
func (c *Catalog) EnvironmentOf(model string) (Environment, bool) {
|
||||
m, ok := c.Resolve(model)
|
||||
if !ok || m.ComfyEnvironment() == "" {
|
||||
return Environment{}, false
|
||||
}
|
||||
for _, e := range c.Environments() {
|
||||
if e.Name == m.ComfyEnvironment() {
|
||||
return e, true
|
||||
}
|
||||
}
|
||||
return Environment{}, false
|
||||
}
|
||||
|
||||
// environments builds the named environments and refuses one whose models
|
||||
// cannot share a replica: two commits of one node, or two ranges of one
|
||||
// package, of which one Python can hold only one.
|
||||
func (c *Catalog) environments() ([]Environment, error) {
|
||||
byName := map[string]*Environment{}
|
||||
var order []string
|
||||
// Who brought each node and each package into each environment, to name
|
||||
// both models when two disagree.
|
||||
nodeFrom := map[string]map[string]string{} // env -> repo -> model
|
||||
nodeAt := map[string]map[string]string{} // env -> repo -> commit
|
||||
pkgFrom := map[string]map[string]string{} // env -> package -> model
|
||||
pkgSpec := map[string]map[string]string{} // env -> package -> spec
|
||||
for _, name := range c.order {
|
||||
m := c.models[name]
|
||||
env := m.ComfyEnvironment()
|
||||
if env == "" || m.IsEnvironment() {
|
||||
continue
|
||||
}
|
||||
if !envName.MatchString(env) {
|
||||
return nil, fmt.Errorf("model %q: comfyui.environment %q is not a name of lowercase letters, digits, '.', '_' and '-'",
|
||||
name, env)
|
||||
}
|
||||
if !m.ServesComfyUI() || m.External != nil {
|
||||
return nil, fmt.Errorf("model %q: comfyui.environment is for a model the cluster's ComfyUI serves", name)
|
||||
}
|
||||
e := byName[env]
|
||||
if e == nil {
|
||||
e = &Environment{Name: env}
|
||||
byName[env] = e
|
||||
order = append(order, env)
|
||||
nodeFrom[env], nodeAt[env] = map[string]string{}, map[string]string{}
|
||||
pkgFrom[env], pkgSpec[env] = map[string]string{}, map[string]string{}
|
||||
}
|
||||
e.Models = append(e.Models, name)
|
||||
for _, src := range m.WeightSources() {
|
||||
if !slices.Contains(e.Sources, src) {
|
||||
e.Sources = append(e.Sources, src)
|
||||
}
|
||||
}
|
||||
for _, n := range m.ComfyUI.Nodes {
|
||||
repo := strings.TrimSuffix(strings.TrimRight(n.Repo, "/"), ".git")
|
||||
if at, seen := nodeAt[env][repo]; seen {
|
||||
if at != n.Commit {
|
||||
return nil, fmt.Errorf("environment %q: models %q and %q name custom node %s at different commits (%s, %s): "+
|
||||
"one replica holds one of them", env, nodeFrom[env][repo], name, n.Repo, short(at), short(n.Commit))
|
||||
}
|
||||
} else {
|
||||
nodeAt[env][repo], nodeFrom[env][repo] = n.Commit, name
|
||||
e.Nodes = append(e.Nodes, CustomNode{Repo: n.Repo, Commit: n.Commit})
|
||||
}
|
||||
i := slices.IndexFunc(e.Nodes, func(x CustomNode) bool {
|
||||
return strings.TrimSuffix(strings.TrimRight(x.Repo, "/"), ".git") == repo
|
||||
})
|
||||
for _, b := range n.Build {
|
||||
if !slices.Contains(e.Nodes[i].Build, b) {
|
||||
e.Nodes[i].Build = append(e.Nodes[i].Build, b)
|
||||
}
|
||||
}
|
||||
for _, r := range n.Requirements {
|
||||
pkg, spec := requirementName(r), normalizeSpec(r)
|
||||
if prev, seen := pkgSpec[env][pkg]; seen {
|
||||
if prev != spec {
|
||||
return nil, fmt.Errorf("environment %q: models %q and %q ask for %s as %q and %q: "+
|
||||
"one Python holds one version; name the same range in both",
|
||||
env, pkgFrom[env][pkg], name, pkg, prev, spec)
|
||||
}
|
||||
continue
|
||||
}
|
||||
pkgSpec[env][pkg], pkgFrom[env][pkg] = spec, name
|
||||
// The requirement goes with the node that first named it:
|
||||
// what the replica installs is the union, and each once.
|
||||
e.Nodes[i].Requirements = append(e.Nodes[i].Requirements, strings.TrimSpace(r))
|
||||
}
|
||||
}
|
||||
}
|
||||
out := make([]Environment, 0, len(order))
|
||||
for _, n := range order {
|
||||
out = append(out, *byName[n])
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// requirementName is a requirement's package, as PyPI compares names.
|
||||
func requirementName(spec string) string {
|
||||
s := strings.TrimSpace(spec)
|
||||
if i := strings.IndexAny(s, "<>=!~;[ "); i >= 0 {
|
||||
s = s[:i]
|
||||
}
|
||||
return strings.NewReplacer("_", "-", ".", "-").Replace(strings.ToLower(s))
|
||||
}
|
||||
|
||||
// normalizeSpec is a requirement without its spaces and with its package
|
||||
// named as PyPI compares it, so "transformers >=4.50, <5" and
|
||||
// "Transformers>=4.50,<5" are one range.
|
||||
func normalizeSpec(spec string) string {
|
||||
s := strings.Join(strings.Fields(spec), "")
|
||||
name := requirementName(s)
|
||||
i := strings.IndexAny(s, "<>=!~;[")
|
||||
if i < 0 {
|
||||
return name
|
||||
}
|
||||
return name + s[i:]
|
||||
}
|
||||
|
||||
func short(commit string) string {
|
||||
if len(commit) > 12 {
|
||||
return commit[:12]
|
||||
}
|
||||
return commit
|
||||
}
|
||||
@@ -0,0 +1,114 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const (
|
||||
commitA = "0123456789abcdef0123456789abcdef01234567"
|
||||
commitB = "fedcba9876543210fedcba9876543210fedcba98"
|
||||
)
|
||||
|
||||
func inEnv(name, env, source string, nodes ...CustomNode) Model {
|
||||
m := comfyModel(source, &ComfyUI{Workflow: "w.json", Output: OutputMeshes, Environment: env, Nodes: nodes})
|
||||
m.Name = name
|
||||
return m
|
||||
}
|
||||
|
||||
func TestModelsInOneEnvironmentShareTheirNodesAndWeights(t *testing.T) {
|
||||
sf3d := CustomNode{Repo: "https://github.com/Stability-AI/stable-fast-3d", Commit: commitA,
|
||||
Requirements: []string{"trimesh", "transformers>=4.42,<5"}}
|
||||
tripo := CustomNode{Repo: "https://github.com/flowtyone/ComfyUI-Flowty-TripoSR", Commit: commitB,
|
||||
Requirements: []string{"Transformers >= 4.42, <5", "rembg"}}
|
||||
flux := comfyModel("/w/flux.safetensors", &ComfyUI{Environment: "shared"})
|
||||
cat, err := New([]Model{
|
||||
flux,
|
||||
inEnv("sf3d", "shared", "/w/sf3d/model.safetensors", sf3d),
|
||||
inEnv("triposr", "shared", "/w/tripo/model.ckpt", tripo),
|
||||
inEnv("alone", "", "/w/alone.ckpt"),
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
envs := cat.Environments()
|
||||
if len(envs) != 1 {
|
||||
t.Fatalf("environments %+v", envs)
|
||||
}
|
||||
e := envs[0]
|
||||
if strings.Join(e.Models, ",") != "flux,sf3d,triposr" {
|
||||
t.Errorf("models %v", e.Models)
|
||||
}
|
||||
if len(e.Sources) != 3 || len(e.Nodes) != 2 {
|
||||
t.Errorf("sources %v nodes %+v", e.Sources, e.Nodes)
|
||||
}
|
||||
// transformers once, with the node that named it first; rembg with its own.
|
||||
if got := strings.Join(e.Nodes[0].Requirements, " "); got != "trimesh transformers>=4.42,<5" {
|
||||
t.Errorf("first node's requirements %q", got)
|
||||
}
|
||||
if got := strings.Join(e.Nodes[1].Requirements, " "); got != "rembg" {
|
||||
t.Errorf("second node's requirements %q", got)
|
||||
}
|
||||
if got, ok := cat.EnvironmentOf("sf3d"); !ok || got.Name != "shared" {
|
||||
t.Errorf("sf3d's environment %+v %v", got, ok)
|
||||
}
|
||||
if _, ok := cat.EnvironmentOf("alone"); ok {
|
||||
t.Error("a model with no environment is in one")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnEnvironmentWhoseModelsDisagreeIsRefused(t *testing.T) {
|
||||
node := func(commit string, reqs ...string) CustomNode {
|
||||
return CustomNode{Repo: "https://github.com/a/node", Commit: commit, Requirements: reqs}
|
||||
}
|
||||
for name, c := range map[string]struct {
|
||||
models []Model
|
||||
want string
|
||||
}{
|
||||
"two commits of one node": {[]Model{
|
||||
inEnv("a", "e", "/w/a", node(commitA)), inEnv("b", "e", "/w/b", node(commitB))}, "different commits"},
|
||||
"two ranges of one package": {[]Model{
|
||||
inEnv("a", "e", "/w/a", node(commitA, "numpy<2")),
|
||||
inEnv("b", "e", "/w/b", CustomNode{Repo: "https://github.com/b/other", Commit: commitB,
|
||||
Requirements: []string{"numpy>=2"}})}, `"a" and "b" ask for numpy`},
|
||||
"a bad name": {[]Model{inEnv("a", "Shared Env", "/w/a")}, "comfyui.environment"},
|
||||
} {
|
||||
if _, err := New(c.models); err == nil || !strings.Contains(err.Error(), c.want) {
|
||||
t.Errorf("%s: %v", name, err)
|
||||
}
|
||||
}
|
||||
// The same node at the same commit, the same range written two ways: fine.
|
||||
if _, err := New([]Model{
|
||||
inEnv("a", "e", "/w/a", node(commitA, "numpy >= 2")),
|
||||
inEnv("b", "e", "/w/b", node(commitA, "NumPy>=2")),
|
||||
}); err != nil {
|
||||
t.Errorf("agreeing models refused: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestALicenceIsSaidSoAMachineCanMatchIt(t *testing.T) {
|
||||
yes := true
|
||||
ok := License{ID: "tencent-hunyuan-community", Name: "Tencent Hunyuan Community License", Commercial: &yes,
|
||||
ExcludedRegions: []string{"EU", "GB", "KR"}}
|
||||
m := comfyModel("/w/f.safetensors", nil)
|
||||
m.License = &ok
|
||||
if _, err := New([]Model{m}); err != nil {
|
||||
t.Fatalf("a full licence refused: %v", err)
|
||||
}
|
||||
for name, c := range map[string]struct {
|
||||
l License
|
||||
want string
|
||||
}{
|
||||
"no name": {License{ID: "MIT"}, "license.name"},
|
||||
"a sentence id": {License{ID: "the MIT one", Name: "MIT"}, "license.id"},
|
||||
"a lowercase eu": {License{Name: "x", ExcludedRegions: []string{"eu"}}, "excluded_regions"},
|
||||
"a negative cap": {License{Name: "x", RevenueCapUSD: -1}, "revenue_cap_usd"},
|
||||
} {
|
||||
m := comfyModel("/w/f.safetensors", nil)
|
||||
l := c.l
|
||||
m.License = &l
|
||||
if _, err := New([]Model{m}); err == nil || !strings.Contains(err.Error(), c.want) {
|
||||
t.Errorf("%s: %v", name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/discovery"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/placement"
|
||||
)
|
||||
|
||||
// Profiles that fit the hardware.
|
||||
//
|
||||
// A profile names its GPU class — 6000-24g, a100-80g — and placement matches
|
||||
// it exactly. A catalog entry meant for many sites cannot know their class
|
||||
// names: the PoC has one Turing card, a customer an A100, another an L40S. So
|
||||
// a profile may say what card it needs instead — a compute capability, a
|
||||
// memory — and stands for every class in the cluster that meets it. What
|
||||
// differs between cards goes on the profile too: its own weights (Source),
|
||||
// its own workflow and nodes (ComfyUI), its own engine arguments. The model
|
||||
// then has, say, an fp8 profile for compute 8.9 and up at a higher priority
|
||||
// and an fp16 one for anything with 16 GB, and each site gets the best its
|
||||
// cards can run.
|
||||
|
||||
// GPUNeed is what card a profile needs.
|
||||
type GPUNeed struct {
|
||||
// MinComputeCapability is the oldest architecture that runs it: 7.5 is
|
||||
// Turing, 8.0 Ampere (bf16, flash-attention 2), 8.9 Ada (fp8), 9.0 Hopper.
|
||||
MinComputeCapability float64 `json:"min_compute_capability,omitempty" koanf:"min_compute_capability"`
|
||||
// MinMemoryGB is the card's own memory it needs.
|
||||
MinMemoryGB int `json:"min_memory_gb,omitempty" koanf:"min_memory_gb"`
|
||||
}
|
||||
|
||||
// ProfileComfyUI is what a ComfyUI profile runs differently from the model:
|
||||
// each field set replaces the model's.
|
||||
type ProfileComfyUI struct {
|
||||
Workflow string `json:"workflow,omitempty" koanf:"workflow"`
|
||||
Checkpoint string `json:"checkpoint,omitempty" koanf:"checkpoint"`
|
||||
Nodes []CustomNode `json:"nodes,omitempty" koanf:"nodes"`
|
||||
}
|
||||
|
||||
// GPUKind is one kind of card in the cluster.
|
||||
type GPUKind struct {
|
||||
Class string
|
||||
ComputeCapability float64
|
||||
MemoryGB int
|
||||
}
|
||||
|
||||
// GPUKinds are the kinds of card among gpus, one each, by class.
|
||||
func GPUKinds(gpus []discovery.GPU) []GPUKind {
|
||||
seen := map[string]bool{}
|
||||
var out []GPUKind
|
||||
for _, g := range gpus {
|
||||
c := g.Class()
|
||||
if seen[c] {
|
||||
continue
|
||||
}
|
||||
seen[c] = true
|
||||
cc, _ := strconv.ParseFloat(strings.TrimSpace(g.ComputeCapability), 64)
|
||||
// A MIG instance's memory is the instance's: what a process sees.
|
||||
out = append(out, GPUKind{Class: c, ComputeCapability: cc, MemoryGB: (g.MemoryTotalMB + 512) / 1024})
|
||||
}
|
||||
slices.SortFunc(out, func(a, b GPUKind) int { return strings.Compare(a.Class, b.Class) })
|
||||
return out
|
||||
}
|
||||
|
||||
// Fits reports whether a kind of card meets the need.
|
||||
func (n GPUNeed) Fits(k GPUKind) bool {
|
||||
// A card that does not say its capability is not taken for one that has
|
||||
// it: an fp8 workflow on a card of unknown age fails at its first step.
|
||||
if n.MinComputeCapability > 0 && k.ComputeCapability+1e-9 < n.MinComputeCapability {
|
||||
return false
|
||||
}
|
||||
return n.MinMemoryGB <= 0 || k.MemoryGB >= n.MinMemoryGB
|
||||
}
|
||||
|
||||
func (n GPUNeed) String() string {
|
||||
var parts []string
|
||||
if n.MinComputeCapability > 0 {
|
||||
parts = append(parts, fmt.Sprintf("compute %.1f+", n.MinComputeCapability))
|
||||
}
|
||||
if n.MinMemoryGB > 0 {
|
||||
parts = append(parts, fmt.Sprintf("%d GB+", n.MinMemoryGB))
|
||||
}
|
||||
if len(parts) == 0 {
|
||||
return "any GPU"
|
||||
}
|
||||
return strings.Join(parts, ", ")
|
||||
}
|
||||
|
||||
// forClass is a profile that names its GPU by need, as the one it stands for
|
||||
// on a class.
|
||||
func (p Profile) forClass(class string) Profile {
|
||||
p.Name = p.Name + "@" + class
|
||||
p.GPUClass = class
|
||||
p.GPU = nil
|
||||
return p
|
||||
}
|
||||
|
||||
func (p Profile) validateHardware(m Model) error {
|
||||
if strings.Contains(p.Name, "@") {
|
||||
return fmt.Errorf("model %q profile %q: a profile's name has no '@': it is how one standing for a class is named",
|
||||
m.Name, p.Name)
|
||||
}
|
||||
if p.GPU != nil {
|
||||
if p.GPUClass != "" {
|
||||
return fmt.Errorf("model %q profile %q: gpu_class and gpu are one or the other: a class, or what card it needs",
|
||||
m.Name, p.Name)
|
||||
}
|
||||
if p.GPU.MinComputeCapability < 0 || p.GPU.MinComputeCapability > 20 || p.GPU.MinMemoryGB < 0 {
|
||||
return fmt.Errorf("model %q profile %q: gpu %+v is not a compute capability and a memory", m.Name, p.Name, *p.GPU)
|
||||
}
|
||||
}
|
||||
if p.ComfyUI != nil {
|
||||
if p.Engine != EngineComfyUI {
|
||||
return fmt.Errorf("model %q profile %q: comfyui: is for a profile of engine comfyui", m.Name, p.Name)
|
||||
}
|
||||
if err := checkWorkflow(m.Name, p.ComfyUI.Workflow); err != nil {
|
||||
return err
|
||||
}
|
||||
for _, n := range p.ComfyUI.Nodes {
|
||||
if err := n.validate(m.Name); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// PlacementProfilesFor is a model's profiles in placement's view, each one
|
||||
// that names its GPU by need standing for every kind of card among kinds
|
||||
// that meets it, at its own priority. One that no card meets stands for
|
||||
// none, and is not tried.
|
||||
func (m Model) PlacementProfilesFor(kinds []GPUKind) []placement.Profile {
|
||||
var expanded []Profile
|
||||
for _, p := range m.Profiles {
|
||||
if p.GPU == nil {
|
||||
expanded = append(expanded, p)
|
||||
continue
|
||||
}
|
||||
for _, k := range kinds {
|
||||
if p.GPU.Fits(k) {
|
||||
expanded = append(expanded, p.forClass(k.Class))
|
||||
}
|
||||
}
|
||||
}
|
||||
mm := m
|
||||
mm.Profiles = expanded
|
||||
return mm.PlacementProfiles()
|
||||
}
|
||||
|
||||
// ComfyWorkflowFor is what a profile's replicas are sent: the profile's own
|
||||
// workflow and checkpoint where it has them, else the model's.
|
||||
func (m Model) ComfyWorkflowFor(p Profile) (workflow, checkpoint string) {
|
||||
workflow, checkpoint = m.ComfyWorkflow()
|
||||
if p.ComfyUI != nil {
|
||||
if p.ComfyUI.Workflow != "" {
|
||||
workflow = p.ComfyUI.Workflow
|
||||
}
|
||||
if p.ComfyUI.Checkpoint != "" {
|
||||
checkpoint = p.ComfyUI.Checkpoint
|
||||
}
|
||||
}
|
||||
if p.Source != "" && (p.ComfyUI == nil || p.ComfyUI.Checkpoint == "") && !strings.HasSuffix(p.Source, "/") {
|
||||
// A profile with weights of its own loads them by their own name.
|
||||
checkpoint = lastPathPart(strings.TrimPrefix(p.Source, "hf:"))
|
||||
}
|
||||
return workflow, checkpoint
|
||||
}
|
||||
|
||||
// ComfyNodesFor are the custom nodes a profile's replicas carry.
|
||||
func (m Model) ComfyNodesFor(p Profile) []CustomNode {
|
||||
if p.ComfyUI != nil && p.ComfyUI.Nodes != nil {
|
||||
return p.ComfyUI.Nodes
|
||||
}
|
||||
if m.ComfyUI != nil {
|
||||
return m.ComfyUI.Nodes
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func lastPathPart(s string) string {
|
||||
if i := strings.LastIndex(s, "/"); i >= 0 {
|
||||
return s[i+1:]
|
||||
}
|
||||
return s
|
||||
}
|
||||
@@ -0,0 +1,103 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/discovery"
|
||||
)
|
||||
|
||||
// sf3dByCard is one entry for every site: fp16 on anything with 16 GB, and
|
||||
// a bf16 workflow with its own weights where the card is Ampere or newer.
|
||||
func sf3dByCard() Model {
|
||||
return Model{Name: "sf3d", Source: "/w/sf3d/model.safetensors",
|
||||
ComfyUI: &ComfyUI{Workflow: "/etc/llmgw/workflows/sf3d.json", Output: OutputMeshes},
|
||||
Profiles: []Profile{
|
||||
{Name: "ampere", Engine: EngineComfyUI, TP: 1, Priority: 10, GPU: &GPUNeed{MinComputeCapability: 8.0, MinMemoryGB: 16},
|
||||
Source: "/w/sf3d-bf16/model-bf16.safetensors",
|
||||
ComfyUI: &ProfileComfyUI{Workflow: "/etc/llmgw/workflows/sf3d-bf16.json"}},
|
||||
{Name: "any", Engine: EngineComfyUI, TP: 1, GPU: &GPUNeed{MinMemoryGB: 16}},
|
||||
}}
|
||||
}
|
||||
|
||||
func TestAProfileThatNamesItsCardByNeedStandsForEveryClassThatMeetsIt(t *testing.T) {
|
||||
cat, err := New([]Model{sf3dByCard()})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
m, _ := cat.Resolve("sf3d")
|
||||
turing := GPUKinds([]discovery.GPU{{Name: "Quadro RTX 6000", MemoryTotalMB: 24576, ComputeCapability: "7.5"}})
|
||||
if len(turing) != 1 || turing[0].Class != "6000-24g" || turing[0].ComputeCapability != 7.5 || turing[0].MemoryGB != 24 {
|
||||
t.Fatalf("kinds %+v", turing)
|
||||
}
|
||||
ps := m.PlacementProfilesFor(turing)
|
||||
if len(ps) != 1 || ps[0].Name != "any@6000-24g" || ps[0].GPUClass != "6000-24g" {
|
||||
t.Fatalf("on Turing: %+v", ps)
|
||||
}
|
||||
|
||||
both := GPUKinds([]discovery.GPU{
|
||||
{Name: "Quadro RTX 6000", MemoryTotalMB: 24576, ComputeCapability: "7.5"},
|
||||
{Name: "NVIDIA A100-SXM4-80GB", MemoryTotalMB: 81920, ComputeCapability: "8.0"},
|
||||
{Name: "NVIDIA A100-SXM4-80GB", MemoryTotalMB: 81920, ComputeCapability: "8.0"},
|
||||
{Name: "Tesla T4", MemoryTotalMB: 15360, ComputeCapability: "7.5"},
|
||||
})
|
||||
var names []string
|
||||
for _, p := range m.PlacementProfilesFor(both) {
|
||||
names = append(names, p.Name+"/"+p.GPUClass)
|
||||
}
|
||||
if got := strings.Join(names, " "); got != "ampere@a100-80g/a100-80g any@6000-24g/6000-24g any@a100-80g/a100-80g" {
|
||||
t.Errorf("on a mixed cluster: %s (the T4 has 15 GB, short of 16)", got)
|
||||
}
|
||||
if len(m.PlacementProfiles()) != 0 {
|
||||
t.Error("with no cards known, a profile by need stood for something")
|
||||
}
|
||||
|
||||
// A replica placed as ampere@a100-80g is started with that profile's own
|
||||
// weights, workflow and class.
|
||||
p, ok := m.ProfileByName("ampere@a100-80g")
|
||||
if !ok || p.GPUClass != "a100-80g" || p.GPU != nil || m.SourceOf(p) != "/w/sf3d-bf16/model-bf16.safetensors" {
|
||||
t.Fatalf("profile %+v %v", p, ok)
|
||||
}
|
||||
if w, ckpt := m.ComfyWorkflowFor(p); w != "/etc/llmgw/workflows/sf3d-bf16.json" || ckpt != "model-bf16.safetensors" {
|
||||
t.Errorf("workflow %q checkpoint %q", w, ckpt)
|
||||
}
|
||||
if ep, ok := m.EngineProfile("ampere@a100-80g"); !ok || ep.GPUClass != "a100-80g" || ep.ModelPath != "/w/sf3d-bf16/model-bf16.safetensors" {
|
||||
t.Errorf("engine profile %+v", ep)
|
||||
}
|
||||
if w, ckpt := m.ComfyWorkflowFor(m.Profiles[1]); w != "/etc/llmgw/workflows/sf3d.json" || ckpt != "model.safetensors" {
|
||||
t.Errorf("the fallback's workflow %q checkpoint %q", w, ckpt)
|
||||
}
|
||||
if _, ok := m.ProfileByName("nothing@a100-80g"); ok {
|
||||
t.Error("a profile that is not there was found")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAProfileByNeedIsCheckedLikeAnyOther(t *testing.T) {
|
||||
for name, c := range map[string]struct {
|
||||
p Profile
|
||||
want string
|
||||
}{
|
||||
"both": {Profile{Name: "p", Engine: EngineComfyUI, TP: 1, GPUClass: "a100-80g", GPU: &GPUNeed{MinMemoryGB: 8}}, "one or the other"},
|
||||
"an @ in a name": {Profile{Name: "p@x", Engine: EngineComfyUI, TP: 1, GPUClass: "a100-80g"}, "no '@'"},
|
||||
"a capability of 80": {Profile{Name: "p", Engine: EngineComfyUI, TP: 1, GPU: &GPUNeed{MinComputeCapability: 80}},
|
||||
"compute capability"},
|
||||
"comfyui on vllm": {Profile{Name: "p", Engine: "vllm", TP: 1, GPU: &GPUNeed{}, ComfyUI: &ProfileComfyUI{}},
|
||||
"engine comfyui"},
|
||||
} {
|
||||
m := sf3dByCard()
|
||||
m.Profiles = []Profile{c.p}
|
||||
if c.p.Engine == "vllm" {
|
||||
m.ComfyUI = nil
|
||||
}
|
||||
if _, err := New([]Model{m}); err == nil || !strings.Contains(err.Error(), c.want) {
|
||||
t.Errorf("%s: %v", name, err)
|
||||
}
|
||||
}
|
||||
need := GPUNeed{MinComputeCapability: 8.9}
|
||||
if need.Fits(GPUKind{Class: "x", MemoryGB: 80}) {
|
||||
t.Error("a card that does not say its capability was taken for an Ada")
|
||||
}
|
||||
if !need.Fits(GPUKind{ComputeCapability: 9.0}) || need.String() != "compute 8.9+" {
|
||||
t.Error("a Hopper is not an Ada or newer")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"slices"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Preset is a catalog entry that comes with llmgw: a model whose workflow,
|
||||
// custom nodes, packages and licence somebody has already found and tried,
|
||||
// so that adding it is naming it.
|
||||
//
|
||||
// A ComfyUI model cannot be worked out from its repository the way a GGUF
|
||||
// can: which workflow runs it, which node at which commit, which packages at
|
||||
// which ranges, and under which licence what it makes is shipped are learned
|
||||
// by running it. Written in a document, they were copied by hand on every
|
||||
// site, and a line left out — the node that cuts the picture out — gave
|
||||
// meshes with their background as geometry.
|
||||
type Preset struct {
|
||||
// Makes is what it makes: pictures or meshes.
|
||||
Makes string
|
||||
Model Model
|
||||
}
|
||||
|
||||
// Presets are the entries that come with llmgw, by name. Each profile says
|
||||
// the card it needs rather than naming a class, so the entry places on any
|
||||
// site's cards.
|
||||
func Presets() []Preset {
|
||||
yes := true
|
||||
return []Preset{
|
||||
{
|
||||
Makes: OutputPictures,
|
||||
Model: Model{
|
||||
Name: "flux-schnell",
|
||||
Description: "FLUX.1 [schnell]: pictures from a prompt, in four steps",
|
||||
Source: "hf:Comfy-Org/flux1-schnell/flux1-schnell-fp8.safetensors",
|
||||
ComfyUI: &ComfyUI{Workflow: "flux-schnell"},
|
||||
License: &License{
|
||||
ID: "Apache-2.0", Name: "Apache-2.0", Commercial: &yes,
|
||||
URL: "https://huggingface.co/black-forest-labs/FLUX.1-schnell",
|
||||
Notice: "Made with FLUX.1 [schnell] (Black Forest Labs, Apache 2.0).",
|
||||
},
|
||||
Scaling: Scaling{Min: 0, Max: 1, IdleTimeout: 15 * time.Minute},
|
||||
// The checkpoint is 17 GB with its text encoders; a card with
|
||||
// no fp8 has its weights upcast as they load.
|
||||
Profiles: []Profile{{Name: "gpu", Engine: EngineComfyUI, TP: 1,
|
||||
GPU: &GPUNeed{MinComputeCapability: 7.0, MinMemoryGB: 24}}},
|
||||
},
|
||||
},
|
||||
{
|
||||
Makes: OutputMeshes,
|
||||
Model: Model{
|
||||
Name: "triposr",
|
||||
Description: "TripoSR: a 3D model (GLB) from a picture of one object on a plain background, as a job",
|
||||
Source: "hf:stabilityai/TripoSR/model.ckpt",
|
||||
ComfyUI: &ComfyUI{
|
||||
Workflow: "triposr",
|
||||
Output: OutputMeshes,
|
||||
Nodes: []CustomNode{{
|
||||
Repo: "https://github.com/flowtyone/ComfyUI-Flowty-TripoSR",
|
||||
Commit: "a0c94ac60a7cc062604f61aeeea6d0d493521de3",
|
||||
// transformers 5 renames the checkpoint's keys; rembg
|
||||
// and onnxruntime cut out a picture with no alpha.
|
||||
Requirements: []string{"omegaconf", "trimesh", "scikit-image", "imageio",
|
||||
"transformers>=4.50.3,<5", "huggingface-hub<1", "tokenizers", "rembg", "onnxruntime"},
|
||||
}},
|
||||
},
|
||||
License: &License{
|
||||
ID: "MIT", Name: "MIT", Commercial: &yes,
|
||||
URL: "https://huggingface.co/stabilityai/TripoSR/blob/main/LICENSE",
|
||||
Notice: "Made with TripoSR (Stability AI and Tripo AI, MIT). Its image encoder is " +
|
||||
"facebook/dino-vitb16 (Apache 2.0). TripoSR was trained on a filtered subset of " +
|
||||
"Objaverse, some of whose objects carry their own licences.",
|
||||
},
|
||||
Scaling: Scaling{Min: 0, Max: 1, IdleTimeout: 10 * time.Minute},
|
||||
Profiles: []Profile{{Name: "gpu", Engine: EngineComfyUI, TP: 1,
|
||||
GPU: &GPUNeed{MinComputeCapability: 7.0, MinMemoryGB: 8}}},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// PresetNamed is the preset of that name.
|
||||
func PresetNamed(name string) (Preset, bool) {
|
||||
ps := Presets()
|
||||
i := slices.IndexFunc(ps, func(p Preset) bool { return p.Model.Name == name })
|
||||
if i < 0 {
|
||||
return Preset{}, false
|
||||
}
|
||||
return ps[i], true
|
||||
}
|
||||
|
||||
// PresetNames are the presets' names, in order.
|
||||
func PresetNames() []string {
|
||||
var out []string
|
||||
for _, p := range Presets() {
|
||||
out = append(out, p.Model.Name)
|
||||
}
|
||||
return out
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/comfy"
|
||||
)
|
||||
|
||||
func TestEveryPresetIsACatalogEntryThatLoads(t *testing.T) {
|
||||
var models []Model
|
||||
for _, p := range Presets() {
|
||||
models = append(models, p.Model)
|
||||
}
|
||||
cat, err := New(models)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for _, p := range Presets() {
|
||||
m, ok := cat.Resolve(p.Model.Name)
|
||||
if !ok {
|
||||
t.Fatalf("%s is not in the catalog", p.Model.Name)
|
||||
}
|
||||
if p.Makes == OutputMeshes && !m.MakesMeshes() || p.Makes == OutputPictures && !m.MakesImages() {
|
||||
t.Errorf("%s does not make %s", m.Name, p.Makes)
|
||||
}
|
||||
// A shipped entry has its workflow inside llmgw, not in a file a
|
||||
// site would have to write.
|
||||
w, ckpt := m.ComfyWorkflow()
|
||||
if _, err := comfy.Load(w); err != nil {
|
||||
t.Errorf("%s: %v", m.Name, err)
|
||||
}
|
||||
if ckpt == "" {
|
||||
t.Errorf("%s has no checkpoint", m.Name)
|
||||
}
|
||||
if m.License == nil || m.License.ID == "" || m.License.Commercial == nil {
|
||||
t.Errorf("%s does not say its licence for a machine to match", m.Name)
|
||||
}
|
||||
for _, pr := range m.Profiles {
|
||||
if pr.GPUClass != "" || pr.GPU == nil {
|
||||
t.Errorf("%s/%s names a class: a preset fits any site's cards", m.Name, pr.Name)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPresetIsFoundByName(t *testing.T) {
|
||||
if p, ok := PresetNamed("triposr"); !ok || p.Model.ComfyUI.Workflow != "triposr" {
|
||||
t.Errorf("triposr: %+v %v", p, ok)
|
||||
}
|
||||
if _, ok := PresetNamed("sdxl"); ok {
|
||||
t.Error("a preset that is not there was found")
|
||||
}
|
||||
// Each call is a fresh copy: a caller changing one changes nobody's.
|
||||
a, _ := PresetNamed("triposr")
|
||||
a.Model.ComfyUI.Nodes[0].Requirements[0] = "x"
|
||||
if b, _ := PresetNamed("triposr"); b.Model.ComfyUI.Nodes[0].Requirements[0] == "x" {
|
||||
t.Error("a preset was changed by a caller")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// A shared replica: one ComfyUI serving every model of an environment.
|
||||
//
|
||||
// Each ComfyUI model ran in a replica of its own, so on one card a picture
|
||||
// model and a 3D model took turns, each stopping the other and loading
|
||||
// ComfyUI and its weights from nothing. An environment of two or more models
|
||||
// gets a hidden catalog entry of its own, whose replica carries every
|
||||
// member's weights and custom nodes and answers for each of them; the
|
||||
// members get no replicas of their own. Placement, idleness, eviction and
|
||||
// adoption then work as for any model, on that entry.
|
||||
|
||||
// RoleEnvironment is the role of an environment's hidden entry.
|
||||
const RoleEnvironment = "environment"
|
||||
|
||||
// EnvModelPrefix names an environment's hidden entry: comfyui-env-<name>.
|
||||
const EnvModelPrefix = "comfyui-env-"
|
||||
|
||||
// SharedComfy is what an environment's entry carries of its members.
|
||||
type SharedComfy struct {
|
||||
Environment string `json:"environment"`
|
||||
Members []SharedMember `json:"members"`
|
||||
}
|
||||
|
||||
// SharedMember is one model a shared replica answers for.
|
||||
type SharedMember struct {
|
||||
Name string `json:"name"`
|
||||
Aliases []string `json:"aliases,omitempty"`
|
||||
// Source is the member's weights, which the replica's node fetches.
|
||||
Source string `json:"source"`
|
||||
// HFRepo is the repository its node loads the weights by name from.
|
||||
HFRepo string `json:"hf_repo,omitempty"`
|
||||
// Workflow and Checkpoint are what a request for it is sent.
|
||||
Workflow string `json:"workflow"`
|
||||
Checkpoint string `json:"checkpoint"`
|
||||
}
|
||||
|
||||
// IsEnvironment reports whether a model is an environment's hidden entry.
|
||||
func (m Model) IsEnvironment() bool { return m.Role == RoleEnvironment }
|
||||
|
||||
// SharedBy is the hidden entry whose replica serves a model, when it is in
|
||||
// an environment of two or more.
|
||||
func (c *Catalog) SharedBy(model string) (string, bool) {
|
||||
m, ok := c.Resolve(model)
|
||||
if !ok || m.IsEnvironment() || m.ComfyEnvironment() == "" {
|
||||
return "", false
|
||||
}
|
||||
name := EnvModelPrefix + m.ComfyEnvironment()
|
||||
if _, ok := c.models[name]; !ok {
|
||||
return "", false
|
||||
}
|
||||
return name, true
|
||||
}
|
||||
|
||||
// envModel is the hidden entry for an environment of two or more models: on
|
||||
// the first member's profiles, needing the most memory any of them does,
|
||||
// on demand for the longest idle timeout of theirs.
|
||||
func envModel(env Environment, members []Model) Model {
|
||||
first := members[0]
|
||||
profs := make([]Profile, len(first.Profiles))
|
||||
copy(profs, first.Profiles)
|
||||
mem := 0
|
||||
for _, m := range members {
|
||||
for _, p := range m.Profiles {
|
||||
mem = max(mem, p.MinMemoryGB)
|
||||
}
|
||||
}
|
||||
shared := &SharedComfy{Environment: env.Name}
|
||||
var idle time.Duration
|
||||
minN, maxN := 0, 1
|
||||
class := ""
|
||||
for _, m := range members {
|
||||
workflow, ckpt := m.ComfyWorkflow()
|
||||
hf := ""
|
||||
if m.ComfyUI != nil {
|
||||
hf = m.ComfyUI.HuggingFaceRepo
|
||||
}
|
||||
shared.Members = append(shared.Members, SharedMember{Name: m.Name, Aliases: m.Aliases,
|
||||
Source: m.Source, HFRepo: hf, Workflow: workflow, Checkpoint: ckpt})
|
||||
idle = max(idle, m.Scaling.IdleTimeout)
|
||||
minN, maxN = max(minN, m.Scaling.Min), max(maxN, m.Scaling.Max)
|
||||
if ClassRank(m.EffectiveClass()) > ClassRank(class) || class == "" {
|
||||
class = m.EffectiveClass()
|
||||
}
|
||||
}
|
||||
for i := range profs {
|
||||
profs[i].MinMemoryGB = max(profs[i].MinMemoryGB, mem)
|
||||
profs[i].ComfyUI = nil // the environment's nodes, below
|
||||
profs[i].Source = ""
|
||||
}
|
||||
return Model{
|
||||
Name: EnvModelPrefix + env.Name,
|
||||
Role: RoleEnvironment,
|
||||
Description: "the shared ComfyUI replica of environment " + env.Name,
|
||||
Source: first.Source,
|
||||
ComfyUI: &ComfyUI{Environment: env.Name, Nodes: env.Nodes, Output: OutputEnvironment},
|
||||
Profiles: profs,
|
||||
Scaling: Scaling{Min: minN, Max: maxN, IdleTimeout: idle},
|
||||
Class: class,
|
||||
Shared: shared,
|
||||
}
|
||||
}
|
||||
|
||||
// OutputEnvironment is an environment entry's output: it makes nothing of
|
||||
// its own, its members do.
|
||||
const OutputEnvironment = "environment"
|
||||
@@ -0,0 +1,51 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestAnEnvironmentOfTwoGetsOneHiddenEntryThatServesBoth(t *testing.T) {
|
||||
// flux and a mesh model on one card took turns, each loading ComfyUI
|
||||
// from nothing; in one environment one replica answers for both.
|
||||
flux := comfyModel("/w/flux.safetensors", &ComfyUI{Environment: "art", Workflow: "flux-schnell"})
|
||||
flux.Scaling = Scaling{Max: 1, IdleTimeout: 15 * time.Minute}
|
||||
sf3d := inEnv("sf3d", "art", "/w/sf3d/", CustomNode{Repo: "https://example.com/sf3d", Commit: commitA})
|
||||
sf3d.ComfyUI.HuggingFaceRepo = "stabilityai/stable-fast-3d"
|
||||
sf3d.ComfyUI.Checkpoint = "model.safetensors"
|
||||
sf3d.Scaling = Scaling{Max: 1, IdleTimeout: 10 * time.Minute}
|
||||
cat, err := New([]Model{flux, sf3d, inEnv("alone", "solo", "/w/alone.ckpt")})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
host, ok := cat.SharedBy("sf3d")
|
||||
if !ok || host != "comfyui-env-art" {
|
||||
t.Fatalf("sf3d shared by %q %v", host, ok)
|
||||
}
|
||||
if _, ok := cat.SharedBy("alone"); ok {
|
||||
t.Error("an environment of one got a hidden entry")
|
||||
}
|
||||
em, _ := cat.Resolve(host)
|
||||
if !em.IsEnvironment() || em.MakesImages() || em.MakesMeshes() || em.Scaling.IdleTimeout != 15*time.Minute ||
|
||||
len(em.Shared.Members) != 2 || em.Shared.Members[1].HFRepo != "stabilityai/stable-fast-3d" {
|
||||
t.Errorf("entry %+v", em)
|
||||
}
|
||||
p, ok := em.EngineProfile(em.Profiles[0].Name)
|
||||
if !ok {
|
||||
t.Fatal("no engine profile")
|
||||
}
|
||||
var ms []map[string]string
|
||||
if err := json.Unmarshal([]byte(p.Env[SharedModelsEnv]), &ms); err != nil || len(ms) != 2 || ms[1]["source"] != "/w/sf3d/" {
|
||||
t.Errorf("members for the agent %q %v", p.Env[SharedModelsEnv], err)
|
||||
}
|
||||
if !strings.Contains(p.Env[NodesEnv], "sf3d") {
|
||||
t.Errorf("nodes %q", p.Env[NodesEnv])
|
||||
}
|
||||
// A catalog built again from its own models is the same catalog.
|
||||
again, err := New(cat.Models())
|
||||
if err != nil || len(again.Models()) != len(cat.Models()) {
|
||||
t.Errorf("rebuilt: %v, %d models vs %d", err, len(again.Models()), len(cat.Models()))
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"regexp"
|
||||
"slices"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// What a ComfyUI workflow takes and what it makes, said in the catalog so a
|
||||
// model is data rather than code: a request is checked against its inputs
|
||||
// before a job is written, a client can build a form from /v1/models, and
|
||||
// the answer is picked from the files the workflow saved by its output kind.
|
||||
|
||||
// The kinds of thing a ComfyUI model makes, beside pictures and meshes.
|
||||
const (
|
||||
OutputVideo = "video"
|
||||
OutputAudio = "audio"
|
||||
// OutputFiles is whatever the workflow saves, of any type.
|
||||
OutputFiles = "files"
|
||||
)
|
||||
|
||||
// Outputs are every output kind a ComfyUI model may name.
|
||||
var Outputs = []string{OutputPictures, OutputMeshes, OutputVideo, OutputAudio, OutputFiles}
|
||||
|
||||
// The types of a workflow's input.
|
||||
const (
|
||||
InputText = "text"
|
||||
InputInt = "int"
|
||||
InputFloat = "float"
|
||||
InputBool = "bool"
|
||||
InputChoice = "choice"
|
||||
InputImage = "image"
|
||||
InputMask = "mask"
|
||||
InputAudio = "audio"
|
||||
InputVideo = "video"
|
||||
InputFile = "file"
|
||||
)
|
||||
|
||||
// InputTypes are every type an input may have.
|
||||
var InputTypes = []string{InputText, InputInt, InputFloat, InputBool, InputChoice,
|
||||
InputImage, InputMask, InputAudio, InputVideo, InputFile}
|
||||
|
||||
// Input is one thing a workflow takes from a request: the placeholder
|
||||
// {{name}} in its graph, filled with the request's inputs.name.
|
||||
type Input struct {
|
||||
// Name is the placeholder's, and the request's key.
|
||||
Name string `json:"name" koanf:"name"`
|
||||
// Type is one of text, int, float, bool, choice, image, mask, audio,
|
||||
// video, file. The last five are files, sent as base64, a data URL, or
|
||||
// the id of a file uploaded to /v1/files, and put in ComfyUI's input
|
||||
// directory; the placeholder gets the name they were given there.
|
||||
Type string `json:"type" koanf:"type"`
|
||||
// Required inputs must be in every request; the others take Default,
|
||||
// or the workflow's own {{name|default}}.
|
||||
Required bool `json:"required,omitempty" koanf:"required"`
|
||||
Default any `json:"default,omitempty" koanf:"default"`
|
||||
// Min and Max bound a number; for text, Max bounds its length.
|
||||
Min *float64 `json:"min,omitempty" koanf:"min"`
|
||||
Max *float64 `json:"max,omitempty" koanf:"max"`
|
||||
// Choices are what a choice may be.
|
||||
Choices []string `json:"choices,omitempty" koanf:"choices"`
|
||||
// MaxMB bounds a file input; zero is the type's own bound.
|
||||
MaxMB int `json:"max_mb,omitempty" koanf:"max_mb"`
|
||||
// Doc says what the input is for, to whoever fills it in.
|
||||
Doc string `json:"doc,omitempty" koanf:"doc"`
|
||||
}
|
||||
|
||||
// IsFile reports whether the input is a file put in ComfyUI's input directory.
|
||||
func (in Input) IsFile() bool {
|
||||
switch in.Type {
|
||||
case InputImage, InputMask, InputAudio, InputVideo, InputFile:
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// MaxBytes is the most a file input may be.
|
||||
func (in Input) MaxBytes() int64 {
|
||||
if in.MaxMB > 0 {
|
||||
return int64(in.MaxMB) << 20
|
||||
}
|
||||
switch in.Type {
|
||||
case InputImage, InputMask:
|
||||
return 16 << 20
|
||||
case InputVideo:
|
||||
return 256 << 20
|
||||
}
|
||||
return 64 << 20
|
||||
}
|
||||
|
||||
var inputName = regexp.MustCompile(`^[a-z][a-z0-9_]{0,63}$`)
|
||||
|
||||
func (in Input) validate(model string) error {
|
||||
if !inputName.MatchString(in.Name) {
|
||||
return fmt.Errorf("model %q: input %q is not a name of lowercase letters, digits and '_'", model, in.Name)
|
||||
}
|
||||
if !slices.Contains(InputTypes, in.Type) {
|
||||
return fmt.Errorf("model %q: input %q has type %q, not one of %s", model, in.Name, in.Type, strings.Join(InputTypes, ", "))
|
||||
}
|
||||
if in.Type == InputChoice && len(in.Choices) == 0 {
|
||||
return fmt.Errorf("model %q: input %q is a choice with no choices", model, in.Name)
|
||||
}
|
||||
if in.Type != InputChoice && len(in.Choices) > 0 {
|
||||
return fmt.Errorf("model %q: input %q has choices but is not a choice", model, in.Name)
|
||||
}
|
||||
if in.Min != nil && in.Max != nil && *in.Min > *in.Max {
|
||||
return fmt.Errorf("model %q: input %q has min above max", model, in.Name)
|
||||
}
|
||||
if in.Required && in.Default != nil {
|
||||
return fmt.Errorf("model %q: input %q is required and has a default: it is one or the other", model, in.Name)
|
||||
}
|
||||
if in.IsFile() && in.Default != nil {
|
||||
return fmt.Errorf("model %q: input %q is a file and cannot have a default", model, in.Name)
|
||||
}
|
||||
if in.MaxMB < 0 {
|
||||
return fmt.Errorf("model %q: input %q has a negative max_mb", model, in.Name)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ComfyOutput is what a ComfyUI model makes: pictures unless it says.
|
||||
func (m Model) ComfyOutput() string { return m.comfyOutput() }
|
||||
|
||||
// ComfyInputs are what a ComfyUI model's workflow takes from a request.
|
||||
func (m Model) ComfyInputs() []Input {
|
||||
if m.ComfyUI == nil {
|
||||
return nil
|
||||
}
|
||||
return m.ComfyUI.Inputs
|
||||
}
|
||||
|
||||
// RunsWorkflows reports whether a model answers /v1/workflows/runs: any the
|
||||
// cluster's ComfyUI or a ComfyUI outside it serves.
|
||||
func (m Model) RunsWorkflows() bool { return m.ServesComfyUI() }
|
||||
|
||||
func validOutput(model, out string) error {
|
||||
if !slices.Contains(Outputs, out) {
|
||||
return fmt.Errorf("model %q: comfyui.output %q is not one of %s", model, out, strings.Join(Outputs, ", "))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateInputs(model string, inputs []Input) error {
|
||||
seen := map[string]bool{}
|
||||
for _, in := range inputs {
|
||||
if err := in.validate(model); err != nil {
|
||||
return err
|
||||
}
|
||||
if seen[in.Name] {
|
||||
return fmt.Errorf("model %q: input %q is declared twice", model, in.Name)
|
||||
}
|
||||
seen[in.Name] = true
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestAWorkflowsInputsAreCheckedWhenTheCatalogIsBuilt(t *testing.T) {
|
||||
one := 1.0
|
||||
zero := 0.0
|
||||
run := func(out string, inputs ...Input) Model {
|
||||
return comfyModel("/w/ace.safetensors", &ComfyUI{Workflow: "w.json", Output: out, Inputs: inputs})
|
||||
}
|
||||
cat, err := New([]Model{run(OutputAudio,
|
||||
Input{Name: "tags", Type: InputText, Required: true},
|
||||
Input{Name: "strength", Type: InputFloat, Min: &zero, Max: &one, Default: 0.5},
|
||||
Input{Name: "style", Type: InputChoice, Choices: []string{"pop"}},
|
||||
Input{Name: "clip", Type: InputVideo, MaxMB: 512})})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
m, _ := cat.Resolve("flux")
|
||||
if !m.RunsWorkflows() || m.MakesImages() || m.MakesMeshes() || m.ComfyOutput() != OutputAudio || len(m.ComfyInputs()) != 4 {
|
||||
t.Errorf("an audio model: runs %v pictures %v meshes %v output %q", m.RunsWorkflows(), m.MakesImages(), m.MakesMeshes(), m.ComfyOutput())
|
||||
}
|
||||
if m.ComfyInputs()[3].MaxBytes() != 512<<20 || (Input{Type: InputImage}).MaxBytes() != 16<<20 {
|
||||
t.Error("a file input's bound")
|
||||
}
|
||||
for name, c := range map[string]struct {
|
||||
m Model
|
||||
want string
|
||||
}{
|
||||
"an unknown kind": {run("hologram"), "not one of pictures"},
|
||||
"video, no workflow": {comfyModel("/w/x", &ComfyUI{Output: OutputVideo}), "makes video names its workflow"},
|
||||
"a capital name": {run(OutputAudio, Input{Name: "Tags", Type: InputText}), "lowercase"},
|
||||
"an unknown type": {run(OutputAudio, Input{Name: "x", Type: "colour"}), "not one of text"},
|
||||
"a choice of nothing": {run(OutputAudio, Input{Name: "x", Type: InputChoice}), "no choices"},
|
||||
"min above max": {run(OutputAudio, Input{Name: "x", Type: InputInt, Min: &one, Max: &zero}), "min above max"},
|
||||
"required and default": {run(OutputAudio, Input{Name: "x", Type: InputInt, Required: true, Default: 3}), "one or the other"},
|
||||
"a file's default": {run(OutputAudio, Input{Name: "x", Type: InputImage, Default: "a.png"}), "cannot have a default"},
|
||||
"twice": {run(OutputAudio, Input{Name: "x", Type: InputText}, Input{Name: "x", Type: InputInt}), "declared twice"},
|
||||
} {
|
||||
if _, err := New([]Model{c.m}); err == nil || !strings.Contains(err.Error(), c.want) {
|
||||
t.Errorf("%s: %v", name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -371,8 +371,37 @@ func (c *Controller) endpoints() []endpoint.Info {
|
||||
Weight: rep.Weight,
|
||||
Priority: prof.Priority,
|
||||
}
|
||||
if m.Shared != nil {
|
||||
// One replica answering for every member of its environment:
|
||||
// offered under their names, each sent its own workflow and
|
||||
// checkpoint. Its own hidden name nobody asks for.
|
||||
info.Models = nil
|
||||
info.Comfy = map[string]endpoint.ComfyRoute{}
|
||||
ok := true
|
||||
for _, sm := range m.Shared.Members {
|
||||
w, err := c.workflow(sm.Workflow)
|
||||
if err != nil {
|
||||
c.log.Warn("a shared ComfyUI member's workflow could not be read; its replica is not offered",
|
||||
"model", sm.Name, "replica", rep.ID, "err", err)
|
||||
ok = false
|
||||
break
|
||||
}
|
||||
route := endpoint.ComfyRoute{Workflow: w, Checkpoint: sm.Checkpoint}
|
||||
for _, n := range append([]string{sm.Name}, sm.Aliases...) {
|
||||
info.Models = append(info.Models, n)
|
||||
info.Comfy[n] = route
|
||||
}
|
||||
if info.Workflow == "" {
|
||||
info.Workflow, info.UpstreamModel = w, sm.Checkpoint
|
||||
}
|
||||
}
|
||||
if ok {
|
||||
out = append(out, info)
|
||||
}
|
||||
continue
|
||||
}
|
||||
if prof.Engine == catalog.EngineComfyUI {
|
||||
workflow, ckpt := m.ComfyWorkflow()
|
||||
workflow, ckpt := m.ComfyWorkflowFor(prof)
|
||||
w, err := c.workflow(workflow)
|
||||
if err != nil {
|
||||
c.log.Warn("a ComfyUI model's workflow could not be read; its replica is not offered",
|
||||
|
||||
@@ -92,7 +92,7 @@ func (s *Server) addCandidate(ctx context.Context, j *Job, p prepared, cn catalo
|
||||
s.step(j, "smoke test", Running, "asking "+r.ID+" to say hello")
|
||||
var reply string
|
||||
var tps float64
|
||||
if reply, tps, err = s.smoke(ctx, r, cand); err == nil {
|
||||
if reply, tps, err = s.smoke(ctx, r, cand, s.embeds(cand)); err == nil {
|
||||
s.step(j, "smoke test", Done, fmt.Sprintf("answered at %.1f tokens/s: %q", tps, reply))
|
||||
} else {
|
||||
s.step(j, "smoke test", Failed, err.Error())
|
||||
|
||||
@@ -153,6 +153,13 @@ type Request struct {
|
||||
// is written into the catalog, where clients and editors read it. Check
|
||||
// a running replica with llmgw ctl tool-check before saying so.
|
||||
Tools bool `json:"tools,omitempty"`
|
||||
// Embeddings serves it as an embedding model, which its GGUF header
|
||||
// says by itself for most: --embedding, many slots, a batch that holds
|
||||
// a whole passage, /v1/embeddings.
|
||||
Embeddings bool `json:"embeddings,omitempty"`
|
||||
// sized is the caller having said --ctx-pool or --context-length, which
|
||||
// an embedding model's defaults then leave alone.
|
||||
sized bool
|
||||
// CPUCores is what a replica computes on; zero takes half the smallest
|
||||
// node it fits on.
|
||||
CPUCores int `json:"cpu_cores,omitempty"`
|
||||
@@ -268,6 +275,7 @@ func (s *Server) Start(req Request) (Job, error) {
|
||||
if req.GuardFormat != "" && req.Replicas == 0 {
|
||||
return Job{}, errors.New("a judge model must always run: give it --replicas 1 or more, not --on-demand")
|
||||
}
|
||||
req.sized = req.CtxPool > 0 || req.ContextLength > 0
|
||||
if req.CtxPool <= 0 {
|
||||
req.CtxPool = 16384
|
||||
}
|
||||
@@ -473,6 +481,30 @@ func (s *Server) run(j *Job) {
|
||||
}
|
||||
header = v.Header
|
||||
}
|
||||
if header.Embedding {
|
||||
req.Embeddings = true
|
||||
}
|
||||
if req.Embeddings && !req.sized {
|
||||
// Many passages at once rather than four: an import of a hundred
|
||||
// thousand chunks went at the pace of four slots with the card a
|
||||
// third busy.
|
||||
req.ContextLength, req.CtxPool = embedSlotTokens, embedSlotTokens*embedSlots
|
||||
}
|
||||
// On one card, the weights and the context's cache have to fit it: a
|
||||
// 70B with a 65536-token pool on a 24 GB card loaded its weights and then
|
||||
// failed to make its context, every time, as did an 8B with 131072.
|
||||
if len(layout) > 0 && layout[0].Class != "" && !layout[0].CPU {
|
||||
fitted, why, err := fitPoolToCard(req, header, set.Bytes, layout[0].Class, max(layout[0].GPUsPerNode, 1))
|
||||
if err != nil {
|
||||
s.fail(j, "check", err)
|
||||
return
|
||||
}
|
||||
if why != "" {
|
||||
s.step(j, "check", Running, why)
|
||||
req = fitted
|
||||
}
|
||||
}
|
||||
j.Request = req
|
||||
memGB := int((header.MemoryBytes(set.Bytes, req.CtxPool) + 1<<30 - 1) >> 30)
|
||||
basis := fmt.Sprintf("weights %.1f GB + KV cache %.1f GB for %d tokens + engine",
|
||||
gb(set.Bytes), gb(int64(req.CtxPool)*header.KVBytesPerToken()), req.CtxPool)
|
||||
@@ -587,10 +619,24 @@ func profilesFor(layout []modelplan.Option, req Request, memGB, cores int) []cat
|
||||
// slots of 8192, and the gateway, told 32768, sent requests the engine then
|
||||
// refused.
|
||||
func llamaArgs(req Request) []string {
|
||||
return []string{"--ctx-size", strconv.Itoa(req.CtxPool),
|
||||
args := []string{"--ctx-size", strconv.Itoa(req.CtxPool),
|
||||
"--parallel", strconv.Itoa(max(1, req.CtxPool/req.ContextLength))}
|
||||
if req.Embeddings {
|
||||
// A passage is embedded in one batch: with the default 512, one of
|
||||
// 516 tokens was refused.
|
||||
n := strconv.Itoa(req.ContextLength)
|
||||
args = append([]string{"--embedding"}, append(args, "--batch-size", n, "--ubatch-size", n)...)
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
||||
// An embedding model's slots, when its caller did not size them: passages
|
||||
// of up to a thousand tokens, thirty-two at a time.
|
||||
const (
|
||||
embedSlotTokens = 1024
|
||||
embedSlots = 32
|
||||
)
|
||||
|
||||
// maxOutput is the longest answer the catalog allows: a quarter of the
|
||||
// context, from 1024 to 8192. 1024 everywhere cut an editor's agent off in
|
||||
// the middle of the file it was writing.
|
||||
@@ -620,7 +666,7 @@ func (s *Server) addAndStart(ctx context.Context, j *Job, repo hf.Repo, set hf.F
|
||||
RoutingProfile: "chat", ContextLength: req.ContextLength, MaxOutput: maxOutput(req.ContextLength),
|
||||
Profiles: profs,
|
||||
Scaling: catalog.Scaling{Min: req.Replicas, Max: max(req.Replicas, 1)},
|
||||
Capabilities: catalog.Capabilities{Vision: req.Projector != "", Tools: req.Tools},
|
||||
Capabilities: catalog.Capabilities{Vision: req.Projector != "", Tools: req.Tools, Embeddings: req.Embeddings},
|
||||
Origin: &catalog.Origin{Repo: repo.ID, Revision: repo.Revision, Files: originFiles(set)},
|
||||
}
|
||||
if req.GuardFormat != "" {
|
||||
@@ -655,7 +701,7 @@ func (s *Server) addAndStart(ctx context.Context, j *Job, repo hf.Repo, set hf.F
|
||||
|
||||
// 6. Does it answer.
|
||||
s.step(j, "smoke test", Running, "asking "+rep.ID+" to say hello")
|
||||
reply, tps, err := s.smoke(ctx, rep, name)
|
||||
reply, tps, err := s.smoke(ctx, rep, name, req.Embeddings)
|
||||
if err != nil {
|
||||
s.fail(j, "smoke test", err)
|
||||
return
|
||||
@@ -859,7 +905,10 @@ func (s *Server) waitReady(ctx context.Context, j *Job, name string, hardware bo
|
||||
}
|
||||
|
||||
// smoke sends one short request straight to the replica, with its engine key.
|
||||
func (s *Server) smoke(ctx context.Context, r reconciler.Replica, name string) (string, float64, error) {
|
||||
func (s *Server) smoke(ctx context.Context, r reconciler.Replica, name string, embeddings bool) (string, float64, error) {
|
||||
if embeddings {
|
||||
return s.smokeEmbeddings(ctx, r, name)
|
||||
}
|
||||
body, _ := json.Marshal(map[string]any{
|
||||
"model": name,
|
||||
"max_tokens": 32,
|
||||
@@ -989,3 +1038,77 @@ func pickSafetensors(repo hf.Repo, _ Request) (hf.FileSet, error) {
|
||||
}
|
||||
return set, nil
|
||||
}
|
||||
|
||||
// smokeEmbeddings asks an embedding model for one vector, and says its
|
||||
// length: an embedding model does not chat.
|
||||
func (s *Server) smokeEmbeddings(ctx context.Context, r reconciler.Replica, name string) (string, float64, error) {
|
||||
body, _ := json.Marshal(map[string]any{"model": name, "input": "hello"})
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost,
|
||||
strings.TrimRight(r.Endpoint, "/")+"/v1/embeddings", bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return "", 0, err
|
||||
}
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
if k := s.deps.Fleet.EngineKey(r.ID); k != "" {
|
||||
req.Header.Set("Authorization", "Bearer "+k)
|
||||
}
|
||||
resp, err := s.deps.HTTP.Do(req)
|
||||
if err != nil {
|
||||
return "", 0, err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
b, _ := io.ReadAll(io.LimitReader(resp.Body, 4<<20))
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", 0, fmt.Errorf("the replica answered %s: %s", resp.Status, strings.TrimSpace(string(b)))
|
||||
}
|
||||
var out struct {
|
||||
Data []struct {
|
||||
Embedding []float64 `json:"embedding"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(b, &out); err != nil || len(out.Data) == 0 || len(out.Data[0].Embedding) == 0 {
|
||||
return "", 0, fmt.Errorf("the replica answered no vector: %s", strings.TrimSpace(string(b)))
|
||||
}
|
||||
return fmt.Sprintf("a vector of %d dimensions", len(out.Data[0].Embedding)), 0, nil
|
||||
}
|
||||
|
||||
// embeds is whether the catalog serves name as an embedding model, for a
|
||||
// smoke test of one already there (a canary, an update).
|
||||
func (s *Server) embeds(name string) bool {
|
||||
if s.deps.Current == nil {
|
||||
return false
|
||||
}
|
||||
for _, m := range s.deps.Current() {
|
||||
if m.Name == name {
|
||||
return m.Capabilities.Embeddings
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// fitPoolToCard shrinks a context pool the cards cannot hold to one they
|
||||
// can, saying so, and refuses weights that do not fit at all. The slots stay
|
||||
// as many as asked while each keeps 2048 tokens, then fewer.
|
||||
func fitPoolToCard(req Request, h gguf.Header, weights int64, class string, gpus int) (Request, string, error) {
|
||||
maxTok := h.PoolThatFits(weights, gguf.ClassMemGB(class), gpus)
|
||||
switch {
|
||||
case maxTok == 0 || req.CtxPool <= maxTok:
|
||||
return req, "", nil
|
||||
case maxTok < 0:
|
||||
return req, "", fmt.Errorf("its weights (%.1f GB) do not fit %d card(s) of %s with room to run: "+
|
||||
"choose a smaller quantisation, or more cards", gb(weights), gpus, class)
|
||||
}
|
||||
slots := max(1, req.CtxPool/max(req.ContextLength, 1))
|
||||
for slots > 1 && maxTok/slots < 2048 {
|
||||
slots--
|
||||
}
|
||||
per := (maxTok / slots) / 1024 * 1024
|
||||
if per < 1024 {
|
||||
return req, "", fmt.Errorf("its weights (%.1f GB) leave room on %s for a context of %d tokens only",
|
||||
gb(weights), class, maxTok)
|
||||
}
|
||||
was := req.CtxPool
|
||||
req.ContextLength, req.CtxPool = per, per*slots
|
||||
return req, fmt.Sprintf("a %d-token pool does not fit %s beside %.1f GB of weights: %d slots of %d tokens instead",
|
||||
was, class, gb(weights), slots, per), nil
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"context"
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/gguf"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"slices"
|
||||
@@ -397,3 +398,33 @@ func TestOnlyTheLastFinishedJobsAreRemembered(t *testing.T) {
|
||||
t.Error("the oldest finished job is still remembered")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnEmbeddingModelIsServedForEmbedding(t *testing.T) {
|
||||
// Four slots and a 512-token batch: an import went at four passages a
|
||||
// pass, and one passage of 516 tokens was refused.
|
||||
args := strings.Join(llamaArgs(Request{Embeddings: true, ContextLength: embedSlotTokens,
|
||||
CtxPool: embedSlotTokens * embedSlots}), " ")
|
||||
for _, want := range []string{"--embedding", "--ctx-size 32768", "--parallel 32", "--batch-size 1024", "--ubatch-size 1024"} {
|
||||
if !strings.Contains(args, want) {
|
||||
t.Errorf("%q not in %q", want, args)
|
||||
}
|
||||
}
|
||||
if args := strings.Join(llamaArgs(Request{ContextLength: 4096, CtxPool: 16384}), " "); strings.Contains(args, "embedding") {
|
||||
t.Errorf("a chat model got %q", args)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPoolTheCardCannotHoldIsShrunkNotStarted(t *testing.T) {
|
||||
h := gguf.Header{Architecture: "apertus", BlockCount: 32, HeadCount: 32, HeadCountKV: 8, EmbeddingLength: 4096}
|
||||
req := Request{CtxPool: 131072, ContextLength: 32768}
|
||||
got, why, err := fitPoolToCard(req, h, int64(8.5*(1<<30)), "6000-24g", 1)
|
||||
if err != nil || why == "" || got.CtxPool > 105000 || got.CtxPool/got.ContextLength != 4 {
|
||||
t.Errorf("fitted %+v %q %v", got, why, err)
|
||||
}
|
||||
if _, _, err := fitPoolToCard(req, h, int64(30*(1<<30)), "6000-24g", 1); err == nil {
|
||||
t.Error("weights larger than the card were not refused")
|
||||
}
|
||||
if got, why, _ := fitPoolToCard(Request{CtxPool: 16384, ContextLength: 4096}, h, int64(8.5*(1<<30)), "6000-24g", 1); why != "" || got.CtxPool != 16384 {
|
||||
t.Errorf("a pool that fits was changed: %+v %q", got, why)
|
||||
}
|
||||
}
|
||||
@@ -689,7 +689,7 @@ func (s *Server) replace(ctx context.Context, j *Job, name string) error {
|
||||
}
|
||||
s.step(j, "replicas", Done, fmt.Sprintf("%d replaced", len(old)))
|
||||
s.step(j, "smoke test", Running, "asking "+ready[0].ID+" to say hello")
|
||||
reply, tps, err := s.smoke(ctx, ready[0], name)
|
||||
reply, tps, err := s.smoke(ctx, ready[0], name, s.embeds(name))
|
||||
if err != nil {
|
||||
s.step(j, "smoke test", Failed, err.Error())
|
||||
return err
|
||||
|
||||
@@ -119,6 +119,14 @@ func (r *Reconciler) Adopt(nodeID string, shards []AdoptedShard) (unclaimed []Ad
|
||||
if _, asked := r.wanted[m.Name]; !asked && m.Scaling.OnDemand() {
|
||||
r.wanted[m.Name] = r.now()
|
||||
}
|
||||
// And counted as used now, for the same reason. Left unknown it was
|
||||
// never idle enough to evict: a 3D job waited out the whole fifteen
|
||||
// minutes of a picture model nobody had asked for since the restart.
|
||||
// A replica in use is reported by the router within seconds, and
|
||||
// moves this forward.
|
||||
if m.Scaling.OnDemand() {
|
||||
rep.LastUsedAt = r.now()
|
||||
}
|
||||
}
|
||||
return unclaimed
|
||||
}
|
||||
|
||||
@@ -55,7 +55,7 @@ func (r *Reconciler) IdleFor(id string) (time.Duration, bool) {
|
||||
// from "there is genuinely nothing serving this", which are different answers
|
||||
// to give a client.
|
||||
func (r *Reconciler) Want(model string) bool {
|
||||
m, ok := r.cat.Load().Resolve(model)
|
||||
m, ok := r.cat.Load().Resolve(r.hostOf(model))
|
||||
if !ok || !m.Scaling.OnDemand() {
|
||||
return false
|
||||
}
|
||||
@@ -127,6 +127,9 @@ func (r *Reconciler) baseFor(m catalog.Model) int {
|
||||
if m.IsExternal() {
|
||||
return 0 // served elsewhere: nothing to place, whatever its scaling says
|
||||
}
|
||||
if _, shared := r.cat.Load().SharedBy(m.Name); shared {
|
||||
return 0 // its environment's replica serves it
|
||||
}
|
||||
if lo := r.minFor(m); !m.Scaling.OnDemand() || lo > 0 {
|
||||
return lo
|
||||
}
|
||||
@@ -199,6 +202,17 @@ type Load struct {
|
||||
// were measured to hold, so scaling down does not land on the edge.
|
||||
func (r *Reconciler) RecordLoad(loads map[string]Load) {
|
||||
now := r.now()
|
||||
// A shared replica's load is its members' together.
|
||||
for name, l := range loads {
|
||||
if host := r.hostOf(name); host != name {
|
||||
h := loads[host]
|
||||
h.Replicas = max(h.Replicas, l.Replicas)
|
||||
h.Running += l.Running
|
||||
h.Waiting += l.Waiting
|
||||
loads[host] = h
|
||||
delete(loads, name)
|
||||
}
|
||||
}
|
||||
// The profile each model's replicas run on, for its measurement; read
|
||||
// before the loop, which holds the lock.
|
||||
running := map[string]string{}
|
||||
@@ -280,3 +294,12 @@ func (r *Reconciler) RecordLoad(loads map[string]Load) {
|
||||
// after a scale-down may be. Below one so that the load that was there a
|
||||
// minute ago does not put them straight back over.
|
||||
const scaleDownHeadroom = 0.7
|
||||
|
||||
// hostOf is the model whose replicas serve name: its environment's hidden
|
||||
// entry when it shares one, else itself.
|
||||
func (r *Reconciler) hostOf(name string) string {
|
||||
if host, ok := r.cat.Load().SharedBy(name); ok {
|
||||
return host
|
||||
}
|
||||
return name
|
||||
}
|
||||
@@ -64,15 +64,39 @@ func (r *Reconciler) makeRoomFor(ctx context.Context, m catalog.Model) bool {
|
||||
attribute.Int("llmgw.candidates", len(candidates)))
|
||||
defer span.End()
|
||||
r.stopReplica(ctx, best.ID, "evicted, idle, to make room for "+m.Name)
|
||||
r.forgetWantIfGone(best.Model, best.ID)
|
||||
return true
|
||||
}
|
||||
|
||||
// forgetWantIfGone takes an evicted model off the wanted list when that was
|
||||
// its last replica. Still wanted, it was placed again on the next pass —
|
||||
// ahead of the model it made room for whenever it came first in the catalog —
|
||||
// and the card went back to the model nobody was asking for. Asked again, it
|
||||
// is wanted again.
|
||||
func (r *Reconciler) forgetWantIfGone(model, stopped string) {
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
for _, rep := range r.replicas {
|
||||
if rep.Model == model && rep.ID != stopped && rep.State.Counts() {
|
||||
return
|
||||
}
|
||||
}
|
||||
delete(r.wanted, model)
|
||||
}
|
||||
|
||||
// evictable lists replicas that could be stopped for a model that needs room,
|
||||
// longest idle first.
|
||||
func (r *Reconciler) evictable(wantedBy string) []evictionCandidate {
|
||||
cat := r.cat.Load()
|
||||
// A member never evicts the replica that serves it.
|
||||
wantedBy = r.hostOf(wantedBy)
|
||||
now := r.now()
|
||||
|
||||
wantRank := -1
|
||||
if w, ok := cat.Resolve(wantedBy); ok {
|
||||
wantRank = catalog.ClassRank(w.EffectiveClass())
|
||||
}
|
||||
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
|
||||
@@ -85,6 +109,12 @@ func (r *Reconciler) evictable(wantedBy string) []evictionCandidate {
|
||||
if !ok || !other.Scaling.OnDemand() {
|
||||
continue
|
||||
}
|
||||
// Not for a model of a lower class: the one put first keeps the
|
||||
// card through its idle timeout, rather than losing it two minutes
|
||||
// into a lull to whatever was asked for next.
|
||||
if catalog.ClassRank(other.EffectiveClass()) > wantRank {
|
||||
continue
|
||||
}
|
||||
// Unknown is not idle. A replica the router has said nothing about —
|
||||
// after a restart, that is all of them — must not be evicted on the
|
||||
// strength of a fact nobody has reported.
|
||||
@@ -92,7 +122,7 @@ func (r *Reconciler) evictable(wantedBy string) []evictionCandidate {
|
||||
continue
|
||||
}
|
||||
idle := now.Sub(rep.LastUsedAt)
|
||||
if idle < r.cfg.EvictionGrace {
|
||||
if idle < r.evictionGrace() {
|
||||
continue
|
||||
}
|
||||
// A replica that has only just started is left alone however idle it
|
||||
@@ -100,7 +130,7 @@ func (r *Reconciler) evictable(wantedBy string) []evictionCandidate {
|
||||
// otherwise take turns evicting each other, paying a model load each
|
||||
// time — and a load is expensive enough that waiting is strictly
|
||||
// better than winning.
|
||||
if !rep.ReadyAt.IsZero() && now.Sub(rep.ReadyAt) < r.cfg.MinLifetime {
|
||||
if !rep.ReadyAt.IsZero() && now.Sub(rep.ReadyAt) < r.minLifetime() {
|
||||
continue
|
||||
}
|
||||
nodes := map[string]struct{}{}
|
||||
@@ -128,3 +158,34 @@ func (r *Reconciler) EvictionReason(model string) string {
|
||||
}
|
||||
return "nothing idle enough to stop"
|
||||
}
|
||||
|
||||
// evictionGrace is how long an on-demand replica must go unasked-for before
|
||||
// another model may have its card: the cluster's setting, else the
|
||||
// configuration's.
|
||||
func (r *Reconciler) evictionGrace() time.Duration {
|
||||
if d := time.Duration(r.evictGrace.Load()); d > 0 {
|
||||
return d
|
||||
}
|
||||
return r.cfg.EvictionGrace
|
||||
}
|
||||
|
||||
// minLifetime is how long a replica is safe from eviction once it is up.
|
||||
func (r *Reconciler) minLifetime() time.Duration {
|
||||
if d := time.Duration(r.minLife.Load()); d > 0 {
|
||||
return d
|
||||
}
|
||||
return r.cfg.MinLifetime
|
||||
}
|
||||
|
||||
// SetEvictionTimes puts the cluster's on_demand settings in force: how long
|
||||
// an idle on-demand replica keeps its card, and how long a new one is safe.
|
||||
// Zero keeps the configuration's.
|
||||
//
|
||||
// On one card shared by several models these are the wait between them: a
|
||||
// 3D job after a picture waited out five minutes of a picture model it no
|
||||
// longer needed.
|
||||
func (r *Reconciler) SetEvictionTimes(afterIdle, minLifetime time.Duration) {
|
||||
r.evictGrace.Store(int64(afterIdle))
|
||||
r.minLife.Store(int64(minLifetime))
|
||||
r.Notify()
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
package reconciler
|
||||
|
||||
import (
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/agent/discovery"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
)
|
||||
|
||||
// gpuKinds are the kinds of card the cluster's nodes have, for a profile that
|
||||
// names its GPU by what it needs rather than by class to stand for.
|
||||
func (r *Reconciler) gpuKinds() []catalog.GPUKind {
|
||||
var gpus []discovery.GPU
|
||||
for _, n := range r.inv.Nodes() {
|
||||
gpus = append(gpus, n.GPUs...)
|
||||
}
|
||||
return catalog.GPUKinds(gpus)
|
||||
}
|
||||
@@ -130,25 +130,126 @@ func (r *Reconciler) ModelHealth() []ModelHealth {
|
||||
// Unservable says why a model cannot be served at all, so a request for it is
|
||||
// told now rather than asked to retry something that will never come up.
|
||||
func (r *Reconciler) Unservable(model string) (string, bool) {
|
||||
m, ok := r.cat.Load().Resolve(model)
|
||||
m, ok := r.cat.Load().Resolve(r.hostOf(model))
|
||||
if !ok {
|
||||
return "", false
|
||||
}
|
||||
cat := r.cat.Load()
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
if p, ok := r.parked[m.Name]; ok {
|
||||
r.mu.Unlock()
|
||||
return fmt.Sprintf("%s failed to start %d times in a row and is not being retried: %s",
|
||||
m.Name, p.Failures, p.Reason), true
|
||||
}
|
||||
var asleepLater []victim
|
||||
for _, rep := range r.replicas {
|
||||
if rep.Model == m.Name && rep.State.Counts() {
|
||||
if !rep.State.Counts() {
|
||||
continue
|
||||
}
|
||||
if rep.Model == m.Name {
|
||||
r.mu.Unlock()
|
||||
return "", false // something is on its way
|
||||
}
|
||||
if other, ok := cat.Resolve(rep.Model); ok && other.Scaling.OnDemand() && len(nodesOf(rep)) == 1 {
|
||||
asleepLater = append(asleepLater, victim{ID: rep.ID, Model: rep.Model})
|
||||
}
|
||||
}
|
||||
if res, ok := r.lastExplain[m.Name]; ok && res.Placement == nil {
|
||||
return m.Name + " cannot be placed on any node: " + firstLine(res.Explain()), true
|
||||
res, ok := r.lastExplain[m.Name]
|
||||
r.mu.Unlock()
|
||||
if !ok || res.Placement != nil {
|
||||
return "", false
|
||||
}
|
||||
return "", false
|
||||
// The cards are held by models that let go of them when idle, which
|
||||
// makeRoomFor hastens once they have been up a while. That is a wait, not
|
||||
// a never: a 3D model asked for straight after a picture, on a cluster
|
||||
// with one card, waits for the picture model to step aside.
|
||||
if m.Scaling.OnDemand() && len(asleepLater) > 0 && r.fitsWithout(m, nil, asleepLater) {
|
||||
return "", false
|
||||
}
|
||||
return m.Name + " cannot be placed on any node: " + firstLine(res.Explain()), true
|
||||
}
|
||||
|
||||
// WaitFor says which model holds the cards an on-demand model is waiting
|
||||
// for, and about how long until it serves: until the holder lets go — evicted
|
||||
// once idle and old enough, or stopped at its own idle timeout — and then its
|
||||
// own start, as long as its last one took. ok is false when it is not waiting
|
||||
// on another model; eta is zero when when the holder lets go is not known.
|
||||
func (r *Reconciler) WaitFor(model string) (heldBy string, eta time.Duration, ok bool) {
|
||||
cat := r.cat.Load()
|
||||
m, found := cat.Resolve(r.hostOf(model))
|
||||
if !found || !m.Scaling.OnDemand() {
|
||||
return "", 0, false
|
||||
}
|
||||
type holder struct {
|
||||
v victim
|
||||
release time.Time
|
||||
}
|
||||
now := r.now()
|
||||
var holders []holder
|
||||
r.mu.Lock()
|
||||
for _, rep := range r.replicas {
|
||||
if !rep.State.Counts() || len(nodesOf(rep)) != 1 {
|
||||
continue
|
||||
}
|
||||
if rep.Model == m.Name {
|
||||
r.mu.Unlock()
|
||||
return "", 0, false // its own replica is on its way
|
||||
}
|
||||
other, found := cat.Resolve(rep.Model)
|
||||
if !found || !other.Scaling.OnDemand() {
|
||||
continue
|
||||
}
|
||||
h := holder{v: victim{ID: rep.ID, Model: rep.Model}}
|
||||
if !rep.LastUsedAt.IsZero() {
|
||||
h.release = rep.LastUsedAt.Add(r.idleTimeout(other))
|
||||
// Evicted sooner, when it is no higher a class than the model
|
||||
// waiting; one put first is waited for to its idle timeout.
|
||||
if catalog.ClassRank(other.EffectiveClass()) <= catalog.ClassRank(m.EffectiveClass()) {
|
||||
evict := rep.LastUsedAt.Add(r.evictionGrace())
|
||||
if !rep.ReadyAt.IsZero() && rep.ReadyAt.Add(r.minLifetime()).After(evict) {
|
||||
evict = rep.ReadyAt.Add(r.minLifetime())
|
||||
}
|
||||
if evict.Before(h.release) {
|
||||
h.release = evict
|
||||
}
|
||||
}
|
||||
}
|
||||
holders = append(holders, h)
|
||||
}
|
||||
cold := r.coldStart[m.Name]
|
||||
r.mu.Unlock()
|
||||
|
||||
// The one whose going alone makes room, letting go soonest; failing
|
||||
// that, all of them, and the last to let go.
|
||||
var best *holder
|
||||
for i := range holders {
|
||||
h := &holders[i]
|
||||
if !r.fitsWithout(m, nil, []victim{h.v}) {
|
||||
continue
|
||||
}
|
||||
if best == nil || (!h.release.IsZero() && (best.release.IsZero() || h.release.Before(best.release))) {
|
||||
best = h
|
||||
}
|
||||
}
|
||||
if best == nil {
|
||||
all := make([]victim, len(holders))
|
||||
for i, h := range holders {
|
||||
all[i] = h.v
|
||||
}
|
||||
if len(all) == 0 || !r.fitsWithout(m, nil, all) {
|
||||
return "", 0, false
|
||||
}
|
||||
for i := range holders {
|
||||
h := &holders[i]
|
||||
if best == nil || h.release.IsZero() || (!best.release.IsZero() && h.release.After(best.release)) {
|
||||
best = h
|
||||
}
|
||||
}
|
||||
}
|
||||
if best.release.IsZero() {
|
||||
return best.v.Model, 0, true
|
||||
}
|
||||
return best.v.Model, max(best.release.Sub(now), 0) + cold, true
|
||||
}
|
||||
|
||||
func firstLine(s string) string {
|
||||
|
||||
@@ -45,7 +45,7 @@ func (r *Reconciler) measured(model, profile string) (Measured, bool) {
|
||||
// Placement sorts by priority itself, so the order found here is written back
|
||||
// as priorities, descending, for it to keep.
|
||||
func (r *Reconciler) orderedProfiles(m catalog.Model) []placement.Profile {
|
||||
ps := m.PlacementProfiles()
|
||||
ps := m.PlacementProfilesFor(r.gpuKinds())
|
||||
eff := make([]float64, len(ps))
|
||||
for i, p := range ps {
|
||||
meas, ok := r.measured(m.Name, p.Name)
|
||||
|
||||
@@ -249,7 +249,7 @@ func (r *Reconciler) victims(m catalog.Model) []victim {
|
||||
aboveMin := i < above
|
||||
tier := -1
|
||||
switch {
|
||||
case rank < myRank && other.Scaling.OnDemand() && idleFor(rep, now) >= r.cfg.EvictionGrace:
|
||||
case rank < myRank && other.Scaling.OnDemand() && idleFor(rep, now) >= r.evictionGrace():
|
||||
tier = 0
|
||||
case rank < myRank && aboveMin:
|
||||
tier = 2
|
||||
@@ -275,7 +275,7 @@ func (r *Reconciler) victims(m catalog.Model) []victim {
|
||||
}
|
||||
// Just started: stopping it throws away a model load that has
|
||||
// only now been paid for.
|
||||
if !rep.ReadyAt.IsZero() && now.Sub(rep.ReadyAt) < r.cfg.MinLifetime {
|
||||
if !rep.ReadyAt.IsZero() && now.Sub(rep.ReadyAt) < r.minLifetime() {
|
||||
continue
|
||||
}
|
||||
if len(nodesOf(rep)) > 1 {
|
||||
|
||||
@@ -264,6 +264,12 @@ type Reconciler struct {
|
||||
// because it is state about this moment and not about what the model is.
|
||||
// A model nobody has wanted has no entry and is simply not running.
|
||||
wanted map[string]time.Time
|
||||
// evictGrace and minLife are the cluster's on_demand settings, as
|
||||
// durations; zero keeps cfg's.
|
||||
evictGrace, minLife atomic.Int64
|
||||
// coldStart is how long each model's last replica took from placed to
|
||||
// ready, for telling a request waiting on it about how long it waits.
|
||||
coldStart map[string]time.Duration
|
||||
// restartQueue holds, per model, the replicas an operator asked to be
|
||||
// restarted and not yet begun. One is replaced at a time: replacing them
|
||||
// all at once would need the memory of every replica twice over.
|
||||
@@ -330,6 +336,7 @@ func New(cfg Config, cat *catalog.Live, inv *inventory.Store, disp Dispatcher, l
|
||||
attempts: map[string]int{},
|
||||
reservedPorts: map[int]struct{}{},
|
||||
wanted: map[string]time.Time{},
|
||||
coldStart: map[string]time.Duration{},
|
||||
restartQueue: map[string][]string{},
|
||||
restartInPlace: map[string]bool{},
|
||||
restartPace: map[string]RestartPace{},
|
||||
@@ -478,6 +485,13 @@ func (r *Reconciler) stopReplicasOfRemovedModels(ctx context.Context) {
|
||||
gone = append(gone, rep)
|
||||
}
|
||||
}
|
||||
// And whether it was wanted: a model removed and added again, to change
|
||||
// its entry, came back loading as if just asked for.
|
||||
for model := range r.wanted {
|
||||
if _, ok := cat.Resolve(model); !ok {
|
||||
delete(r.wanted, model)
|
||||
}
|
||||
}
|
||||
r.mu.Unlock()
|
||||
|
||||
for _, rep := range gone {
|
||||
@@ -1371,6 +1385,9 @@ func (r *Reconciler) markShard(replicaID, shardID string, st supervisor.State, e
|
||||
// counting from scratch rather than from an old streak.
|
||||
r.attempts[rep.Model] = 0
|
||||
delete(r.nextAttempt, rep.Model)
|
||||
if !rep.CreatedAt.IsZero() {
|
||||
r.coldStart[rep.Model] = r.now().Sub(rep.CreatedAt)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -680,6 +680,25 @@ func TestAdoptRebuildsReplica(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnAdoptedOnDemandReplicaNobodyUsesCanBeEvicted(t *testing.T) {
|
||||
// After a restart the picture model, adopted and asked for by nobody,
|
||||
// was never idle enough to evict: a 3D job waited out its whole idle
|
||||
// timeout, told nothing about how long.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Adopt("1", []AdoptedShard{adopted("llama-99", "llama-99-r0", "1", 0, []int{0, 1, 2, 3})})
|
||||
|
||||
h.r.Want("second")
|
||||
h.r.Reconcile(t.Context())
|
||||
if _, eta, ok := h.r.WaitFor("second"); !ok || eta <= 0 {
|
||||
t.Errorf("WaitFor: eta %s, ok %v", eta, ok)
|
||||
}
|
||||
h.advance(DefaultConfig().MinLifetime + time.Minute)
|
||||
if got := h.r.evictable("second"); len(got) != 1 || got[0].ID != "llama-99" {
|
||||
t.Errorf("evictable %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAdoptPreventsDuplicatePlacement(t *testing.T) {
|
||||
// The whole point: after adopting, a reconciliation pass must see the
|
||||
// desired count already met.
|
||||
@@ -1318,6 +1337,72 @@ func TestAModelRemovedWhileRunningIsStopped(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestAModelPutFirstIsNotEvictedForALowerClassOne(t *testing.T) {
|
||||
// The VLM is put first: a picture or 3D model asked for in a lull must
|
||||
// wait for its idle timeout, not take the card two minutes in.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
cat := twoOnDemandModels(t)
|
||||
ms := cat.Models()
|
||||
for i := range ms {
|
||||
if ms[i].Name == "llama" {
|
||||
ms[i].Class = catalog.ClassStandard
|
||||
} else {
|
||||
ms[i].Class = catalog.ClassOpportunistic
|
||||
}
|
||||
}
|
||||
built, err := catalog.New(ms)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h.r.cat.Store(built)
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
reps := h.r.Replicas()
|
||||
h.r.RecordUsage(map[string]time.Time{reps[0].ID: h.clock.now()})
|
||||
h.advance(DefaultConfig().MinLifetime + DefaultConfig().EvictionGrace + time.Minute)
|
||||
|
||||
if got := h.r.evictable("second"); len(got) != 0 {
|
||||
t.Errorf("a standard model was offered to an opportunistic one: %+v", got)
|
||||
}
|
||||
h.r.Want("second")
|
||||
h.r.Reconcile(t.Context())
|
||||
// It waits for the idle timeout (an hour here), and is told so.
|
||||
_, eta, ok := h.r.WaitFor("second")
|
||||
want := time.Hour - (DefaultConfig().MinLifetime + DefaultConfig().EvictionGrace + time.Minute)
|
||||
if !ok || eta != want {
|
||||
t.Errorf("WaitFor: %s %v, want %s", eta, ok, want)
|
||||
}
|
||||
// The other way, it is offered.
|
||||
if got := h.r.evictable("llama"); len(got) != 0 {
|
||||
t.Errorf("nothing of second runs, yet %+v was offered", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnOnDemandModelRemovedAndAddedAgainIsNotLoadedUnasked(t *testing.T) {
|
||||
// The VLM, removed and added again to give it a licence, came back
|
||||
// loading on its own: still on the wanted list from before its removal.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
|
||||
only := mustResolve(t, h, "second")
|
||||
without, err := catalog.New([]catalog.Model{only})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h.r.cat.Store(without)
|
||||
for range 3 {
|
||||
h.r.Reconcile(t.Context())
|
||||
}
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
if n := h.r.baseFor(mustResolve(t, h, "llama")); n != 0 {
|
||||
t.Errorf("added again, it wants %d replicas before anybody asked", n)
|
||||
}
|
||||
}
|
||||
|
||||
// --- on-demand loading and idle eviction ---
|
||||
|
||||
func onDemandModel(idle time.Duration) catalog.Model {
|
||||
@@ -1678,6 +1763,31 @@ func mustResolve(t *testing.T, h *harness, name string) catalog.Model {
|
||||
return m
|
||||
}
|
||||
|
||||
func TestTheClustersOnDemandSettingsShortenTheWaitForACard(t *testing.T) {
|
||||
// One card, a picture model and a 3D model: a mesh after a picture
|
||||
// waited out five minutes of the picture model's protection.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
reps := h.r.Replicas()
|
||||
h.r.RecordUsage(map[string]time.Time{reps[0].ID: h.clock.now()})
|
||||
h.advance(90 * time.Second)
|
||||
if got := h.r.evictable("second"); len(got) != 0 {
|
||||
t.Fatalf("offered at 90 s with the defaults: %+v", got)
|
||||
}
|
||||
h.r.SetEvictionTimes(30*time.Second, time.Minute)
|
||||
if got := h.r.evictable("second"); len(got) != 1 {
|
||||
t.Errorf("not offered at 90 s with 30 s idle and 1 min lifetime: %+v", got)
|
||||
}
|
||||
// Zero goes back to the configuration's.
|
||||
h.r.SetEvictionTimes(0, 0)
|
||||
if got := h.r.evictable("second"); len(got) != 0 {
|
||||
t.Errorf("offered after the settings were cleared: %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAFreshlyStartedReplicaIsNotEvicted(t *testing.T) {
|
||||
// What stops two models on a cluster with room for one from taking turns
|
||||
// evicting each other, paying a model load each time. A load is expensive
|
||||
@@ -1708,6 +1818,109 @@ func TestAFreshlyStartedReplicaIsNotEvicted(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnEvictedModelDoesNotTakeTheCardBack(t *testing.T) {
|
||||
// flux evicted for triposr was placed again two seconds later: still
|
||||
// wanted, and first in the catalog, it won the card it had just given up.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
first := h.r.Replicas()
|
||||
if len(first) != 1 {
|
||||
t.Fatalf("setup: %d replicas", len(first))
|
||||
}
|
||||
h.r.RecordUsage(map[string]time.Time{first[0].ID: h.clock.now()})
|
||||
h.advance(DefaultConfig().MinLifetime + time.Minute)
|
||||
|
||||
h.r.Want("second")
|
||||
for range 4 {
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
h.advance(10 * time.Second)
|
||||
}
|
||||
var models []string
|
||||
for _, rep := range h.r.Replicas() {
|
||||
if rep.State.Counts() {
|
||||
models = append(models, rep.Model)
|
||||
}
|
||||
}
|
||||
if !slices.Equal(models, []string{"second"}) {
|
||||
t.Errorf("running after the eviction: %v, want [second]", models)
|
||||
}
|
||||
|
||||
// Asked for again, it is wanted again.
|
||||
if !h.r.Want("llama") || h.r.baseFor(mustResolve(t, h, "llama")) != 1 {
|
||||
t.Error("an evicted model asked for again is not wanted")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAModelWaitingOnAnotherIsToldWhichAndForAboutHowLong(t *testing.T) {
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
reps := h.r.Replicas()
|
||||
if len(reps) != 1 {
|
||||
t.Fatalf("setup: %d replicas", len(reps))
|
||||
}
|
||||
h.r.RecordUsage(map[string]time.Time{reps[0].ID: h.clock.now()})
|
||||
h.advance(time.Minute)
|
||||
|
||||
h.r.Want("second")
|
||||
h.r.Reconcile(t.Context())
|
||||
// Evicted once it has been up MinLifetime, a minute of which has gone;
|
||||
// second has never started, so there is no start of its to add.
|
||||
by, eta, ok := h.r.WaitFor("second")
|
||||
if !ok || by != "llama" || eta != DefaultConfig().MinLifetime-time.Minute {
|
||||
t.Errorf("WaitFor = %q %s %v", by, eta, ok)
|
||||
}
|
||||
// The model holding the cards waits on nobody.
|
||||
if _, _, ok := h.r.WaitFor("llama"); ok {
|
||||
t.Error("a model with its own replica was said to be waiting")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAModelWaitingForAnotherOnDemandOneToStepAsideIsNotUnservable(t *testing.T) {
|
||||
// A 3D model asked for straight after a picture, on a cluster with one
|
||||
// card: the picture model holds it, too freshly started to evict. That
|
||||
// is a wait — told "cannot be placed", a job failed at once.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 4))
|
||||
h.r.cat.Store(twoOnDemandModels(t))
|
||||
h.r.Want("llama")
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
reps := h.r.Replicas()
|
||||
if len(reps) != 1 {
|
||||
t.Fatalf("setup: %d replicas", len(reps))
|
||||
}
|
||||
h.r.RecordUsage(map[string]time.Time{reps[0].ID: h.clock.now()})
|
||||
|
||||
h.r.Want("second")
|
||||
h.r.Reconcile(t.Context())
|
||||
if res, ok := h.r.lastExplain["second"]; !ok || res.Placement != nil {
|
||||
t.Fatalf("setup: second was not left unplaced: %+v", res)
|
||||
}
|
||||
if why, no := h.r.Unservable("second"); no {
|
||||
t.Errorf("a model waiting for an on-demand one to go idle was called unservable: %q", why)
|
||||
}
|
||||
|
||||
// Held by a model that stays up, the card is not coming back.
|
||||
always := testModel(1)
|
||||
always.Name = "llama"
|
||||
always.Scaling = catalog.Scaling{Min: 1, Max: 1}
|
||||
second := mustResolve(t, h, "second")
|
||||
built, err := catalog.New([]catalog.Model{always, second})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
h.r.cat.Store(built)
|
||||
if _, no := h.r.Unservable("second"); !no {
|
||||
t.Error("a model behind an always-on one was not called unservable")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAStartedShardIsToldWhichProfileVersionItIs(t *testing.T) {
|
||||
// The fingerprint has to leave the control plane, or it cannot come back
|
||||
// after a restart — and a restart is exactly when the configuration is
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
package reconciler
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/catalog"
|
||||
)
|
||||
|
||||
func sharedCatalog(t *testing.T) *catalog.Catalog {
|
||||
t.Helper()
|
||||
mk := func(name, out string) catalog.Model {
|
||||
return catalog.Model{Name: name, Source: "/w/" + name + ".safetensors",
|
||||
ComfyUI: &catalog.ComfyUI{Environment: "art", Workflow: "flux-schnell", Output: out},
|
||||
Scaling: catalog.Scaling{Max: 1, IdleTimeout: time.Hour},
|
||||
Profiles: []catalog.Profile{{Name: "p", Engine: catalog.EngineComfyUI, GPUClass: "h100-80g", TP: 1}}}
|
||||
}
|
||||
cat, err := catalog.New([]catalog.Model{mk("flux", catalog.OutputPictures), mk("sf3d", catalog.OutputMeshes)})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return cat
|
||||
}
|
||||
|
||||
func TestAMemberAskedForStartsItsEnvironmentsOneReplica(t *testing.T) {
|
||||
// A picture model and a 3D model on one card took turns, each from
|
||||
// nothing: in one environment, asking for either starts one replica
|
||||
// that serves both, and neither gets one of its own.
|
||||
h := newHarness(t, testModel(1), gpuNode("1", 1))
|
||||
h.r.cat.Store(sharedCatalog(t))
|
||||
if !h.r.Want("sf3d") {
|
||||
t.Fatal("a member was not wanted")
|
||||
}
|
||||
h.r.Reconcile(t.Context())
|
||||
h.markReady()
|
||||
h.r.Want("flux")
|
||||
h.r.Reconcile(t.Context())
|
||||
var models []string
|
||||
for _, rep := range h.r.Replicas() {
|
||||
if rep.State.Counts() {
|
||||
models = append(models, rep.Model)
|
||||
}
|
||||
}
|
||||
if len(models) != 1 || models[0] != "comfyui-env-art" {
|
||||
t.Fatalf("replicas %v", models)
|
||||
}
|
||||
// The member's sibling never evicts the replica serving it.
|
||||
reps := h.r.Replicas()
|
||||
h.r.RecordUsage(map[string]time.Time{reps[0].ID: h.clock.now()})
|
||||
h.advance(DefaultConfig().MinLifetime + DefaultConfig().EvictionGrace + time.Minute)
|
||||
if got := h.r.evictable("flux"); len(got) != 0 {
|
||||
t.Errorf("a member was offered its own environment's replica: %+v", got)
|
||||
}
|
||||
if _, _, ok := h.r.WaitFor("flux"); ok {
|
||||
t.Error("a member served by a replica that is up was said to be waiting")
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,7 @@ import (
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/clientapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/docgen"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/docgen/openapi"
|
||||
@@ -57,4 +58,15 @@ func main() {
|
||||
os.Exit(1)
|
||||
}
|
||||
fmt.Printf("docs/admin-api.openapi.json: %d routes\n", len(adminapi.Routes))
|
||||
|
||||
spec, err = openapi.GenerateDoc(root, openapi.Client, clientapi.Routes, clientapi.PathParams)
|
||||
if err != nil {
|
||||
fmt.Fprintln(os.Stderr, "error:", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(root, "docs", "client-api.openapi.json"), spec, 0o644); err != nil {
|
||||
fmt.Fprintln(os.Stderr, "error:", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
fmt.Printf("docs/client-api.openapi.json: %d routes\n", len(clientapi.Routes))
|
||||
}
|
||||
@@ -28,6 +28,7 @@ import (
|
||||
"time"
|
||||
"unicode"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/clientapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
)
|
||||
|
||||
@@ -35,10 +36,68 @@ import (
|
||||
// from any other is described without comments.
|
||||
const Module = "gitea.mynodes.xyz/ilker/llmgw"
|
||||
|
||||
// Generate renders the document for routes, reading doc comments from the
|
||||
// Doc is what one document says of itself and its API: the two APIs llmgw
|
||||
// has, the admin listener's and the client's, are described by one
|
||||
// generator from their route tables.
|
||||
type Doc struct {
|
||||
Title, Description string
|
||||
// ServerURL and ServerDescription are where it is served by default.
|
||||
ServerURL, ServerDescription string
|
||||
// Scheme is the bearer token's name in the document, SchemeDescription
|
||||
// what it is.
|
||||
Scheme, SchemeDescription string
|
||||
// Error is a value of the type every refusal answers with.
|
||||
Error any
|
||||
// Prefix is taken off paths to name operations and tags.
|
||||
Prefix string
|
||||
// Home is the package whose types are named alone; others are named
|
||||
// with their package.
|
||||
Home string
|
||||
// Actor is whether changes take the admin API's X-Llmgw-Actor header.
|
||||
Actor bool
|
||||
}
|
||||
|
||||
// Admin is the admin API's document.
|
||||
var Admin = Doc{
|
||||
Title: "llmgw admin API", Description: infoDescription,
|
||||
ServerURL: "http://127.0.0.1:9090", ServerDescription: "The admin listener at its default address, admin_listen.",
|
||||
Scheme: "adminToken",
|
||||
SchemeDescription: "The admin token: the contents of /var/lib/llmgw/admin-token on the " +
|
||||
"control plane (admin_token_file), readable by root and the server. " +
|
||||
"Sent as Authorization: Bearer TOKEN.",
|
||||
Error: adminapi.ErrorView{}, Prefix: "/api/v1/", Home: reflect.TypeOf(adminapi.Route{}).PkgPath(), Actor: true,
|
||||
}
|
||||
|
||||
// Client is the client API's document: the API on :8080 clients use.
|
||||
var Client = Doc{
|
||||
Title: "llmgw client API", Description: clientDescription,
|
||||
ServerURL: "http://localhost:8080", ServerDescription: "A gateway at its default address, listen.",
|
||||
Scheme: "apiKey",
|
||||
SchemeDescription: "An API key, sk-llmgw-…, made with `llmgw keys create` or on the portal's profile page. " +
|
||||
"Sent as Authorization: Bearer KEY; /v1/messages also takes it as x-api-key.",
|
||||
Error: clientapi.Error{}, Prefix: "/v1/", Home: reflect.TypeOf(clientapi.Error{}).PkgPath(),
|
||||
}
|
||||
|
||||
const clientDescription = "OpenAI's API, as llmgw serves it, and what llmgw adds: pictures and 3D models from " +
|
||||
"ComfyUI, knowledge bases, memory notes, stored conversations.\n\n" +
|
||||
"The SDKs of OpenAI and Anthropic work against it unchanged: set the base URL to the gateway's /v1 and the " +
|
||||
"key to an llmgw key. A request carries more than is listed here: what the gateway does not read goes to " +
|
||||
"the engine as it came. Headers llmgw reads: x-llmgw-thread (continue a stored conversation), " +
|
||||
"x-llmgw-knowledge (answer from these collections), x-llmgw-tags (tags kept with the usage), " +
|
||||
"x-session-id (stay on one replica). Headers it sends back: x-request-id, x-llmgw-served-model, " +
|
||||
"x-llmgw-hardware, x-llmgw-seed, and Retry-After when waiting helps.\n\n" +
|
||||
"Generated from the route table in internal/clientapi; see docs/clients.md."
|
||||
|
||||
// Generate renders the admin API's document, reading doc comments from the
|
||||
// repository at root.
|
||||
func Generate(root string, routes []adminapi.Route, pathParams map[string]string) ([]byte, error) {
|
||||
g := &generator{root: root, docs: map[string]map[string]typeDoc{}, names: map[reflect.Type]string{}}
|
||||
return GenerateDoc(root, Admin, routes, pathParams)
|
||||
}
|
||||
|
||||
// GenerateDoc renders one API's document.
|
||||
func GenerateDoc(root string, d Doc, routes []adminapi.Route, pathParams map[string]string) ([]byte, error) {
|
||||
errorType := reflect.TypeOf(d.Error)
|
||||
g := &generator{root: root, docs: map[string]map[string]typeDoc{}, names: map[reflect.Type]string{}, d: d}
|
||||
|
||||
// Every named struct reachable from a body first, so a name two
|
||||
// packages share can be told apart before either is written: by the name
|
||||
@@ -68,7 +127,7 @@ func Generate(root string, routes []adminapi.Route, pathParams map[string]string
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
tags[tagOf(r.Path)] = true
|
||||
tags[g.tagOf(r.Path)] = true
|
||||
item.set(strings.ToLower(r.Method), op)
|
||||
}
|
||||
slices.Sort(order)
|
||||
@@ -92,42 +151,42 @@ func Generate(root string, routes []adminapi.Route, pathParams map[string]string
|
||||
tagList = append(tagList, obj("name", t))
|
||||
}
|
||||
|
||||
components := obj(
|
||||
"securitySchemes", obj(d.Scheme, obj(
|
||||
"type", "http",
|
||||
"scheme", "bearer",
|
||||
"description", d.SchemeDescription,
|
||||
)),
|
||||
)
|
||||
if d.Actor {
|
||||
components.set("parameters", obj("Actor", obj(
|
||||
"name", "X-Llmgw-Actor",
|
||||
"in", "header",
|
||||
"required", false,
|
||||
"description", "Who the change is recorded as made by in the audit log: letters, digits "+
|
||||
"and ._-@, at most 64. unknown when absent.",
|
||||
"schema", obj("type", "string"),
|
||||
)))
|
||||
}
|
||||
components.set("responses", obj(
|
||||
"Error", obj("description", "Refused: the error says why.",
|
||||
"content", obj("application/json", obj("schema", errorSchema))),
|
||||
"Unauthorized", obj("description", "The token is missing or wrong.",
|
||||
"content", obj("application/json", obj("schema", errorSchema))),
|
||||
))
|
||||
components.set("schemas", schemas)
|
||||
doc := obj(
|
||||
"openapi", "3.1.0",
|
||||
"info", obj(
|
||||
"title", "llmgw admin API",
|
||||
"title", d.Title,
|
||||
"version", "v1",
|
||||
"description", infoDescription,
|
||||
"description", d.Description,
|
||||
),
|
||||
"servers", []any{obj("url", "http://127.0.0.1:9090",
|
||||
"description", "The admin listener at its default address, admin_listen.")},
|
||||
"security", []any{obj("adminToken", []any{})},
|
||||
"servers", []any{obj("url", d.ServerURL, "description", d.ServerDescription)},
|
||||
"security", []any{obj(d.Scheme, []any{})},
|
||||
"tags", tagList,
|
||||
"paths", pathsObj,
|
||||
"components", obj(
|
||||
"securitySchemes", obj("adminToken", obj(
|
||||
"type", "http",
|
||||
"scheme", "bearer",
|
||||
"description", "The admin token: the contents of /var/lib/llmgw/admin-token on the "+
|
||||
"control plane (admin_token_file), readable by root and the server. "+
|
||||
"Sent as Authorization: Bearer TOKEN.",
|
||||
)),
|
||||
"parameters", obj("Actor", obj(
|
||||
"name", "X-Llmgw-Actor",
|
||||
"in", "header",
|
||||
"required", false,
|
||||
"description", "Who the change is recorded as made by in the audit log: letters, digits "+
|
||||
"and ._-@, at most 64. unknown when absent.",
|
||||
"schema", obj("type", "string"),
|
||||
)),
|
||||
"responses", obj(
|
||||
"Error", obj("description", "Refused: the error says why.",
|
||||
"content", obj("application/json", obj("schema", errorSchema))),
|
||||
"Unauthorized", obj("description", "The admin token is missing or wrong.",
|
||||
"content", obj("application/json", obj("schema", errorSchema))),
|
||||
),
|
||||
"schemas", schemas,
|
||||
),
|
||||
"components", components,
|
||||
)
|
||||
b, err := marshal(doc)
|
||||
if err != nil {
|
||||
@@ -154,12 +213,12 @@ const infoDescription = "The control plane's management API: what `llmgw ctl` an
|
||||
// operation builds one route's operation object.
|
||||
func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (object, error) {
|
||||
var op object
|
||||
op.set("operationId", operationID(r.Method, r.Path))
|
||||
op.set("operationId", g.operationID(r.Method, r.Path))
|
||||
op.set("summary", r.Summary)
|
||||
if r.Description != "" {
|
||||
op.set("description", r.Description)
|
||||
}
|
||||
op.set("tags", []any{tagOf(r.Path)})
|
||||
op.set("tags", []any{g.tagOf(r.Path)})
|
||||
|
||||
var params []any
|
||||
segs := strings.Split(strings.Trim(r.Path, "/"), "/")
|
||||
@@ -174,7 +233,7 @@ func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (o
|
||||
}
|
||||
desc, ok := pathParams[key]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("%s %s: no description of %s in adminapi.PathParams", r.Method, r.Path, key)
|
||||
return nil, fmt.Errorf("%s %s: no description of %s in the path parameters", r.Method, r.Path, key)
|
||||
}
|
||||
params = append(params, obj("name", name, "in", "path", "required", true,
|
||||
"description", desc, "schema", obj("type", "string")))
|
||||
@@ -192,7 +251,7 @@ func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (o
|
||||
p.set("schema", obj("type", t))
|
||||
params = append(params, p)
|
||||
}
|
||||
if r.Method != "GET" && r.Method != "HEAD" {
|
||||
if g.d.Actor && r.Method != "GET" && r.Method != "HEAD" {
|
||||
params = append(params, obj("$ref", "#/components/parameters/Actor"))
|
||||
}
|
||||
if len(params) > 0 {
|
||||
@@ -200,8 +259,12 @@ func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (o
|
||||
}
|
||||
|
||||
if r.Request != nil {
|
||||
ct := "application/json"
|
||||
if r.Form {
|
||||
ct = "multipart/form-data"
|
||||
}
|
||||
body := obj("required", !r.OptionalBody,
|
||||
"content", obj("application/json", obj("schema", g.schema(reflect.TypeOf(r.Request)))))
|
||||
"content", obj(ct, obj("schema", g.schema(reflect.TypeOf(r.Request)))))
|
||||
op.set("requestBody", body)
|
||||
}
|
||||
|
||||
@@ -209,10 +272,22 @@ func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (o
|
||||
if status == 0 {
|
||||
status = 200
|
||||
}
|
||||
content := obj("application/json", obj("schema", g.schema(reflect.TypeOf(r.Response))))
|
||||
var content object
|
||||
switch {
|
||||
case r.Binary != "":
|
||||
content = obj(r.Binary, obj("schema", obj("type", "string", "format", "binary")))
|
||||
case r.Response == nil:
|
||||
content = obj("application/json", obj("schema", obj()))
|
||||
default:
|
||||
content = obj("application/json", obj("schema", g.schema(reflect.TypeOf(r.Response))))
|
||||
}
|
||||
if r.CSV {
|
||||
content.set("text/csv", obj("schema", obj("type", "string")))
|
||||
}
|
||||
if r.Stream {
|
||||
content.set("text/event-stream", obj("schema", obj("type", "string",
|
||||
"description", "With stream: true, server-sent events: one JSON chunk per data: line, then data: [DONE].")))
|
||||
}
|
||||
desc := "OK"
|
||||
if status == 202 {
|
||||
desc = "Accepted: started, and running on."
|
||||
@@ -226,10 +301,10 @@ func (g *generator) operation(r adminapi.Route, pathParams map[string]string) (o
|
||||
}
|
||||
|
||||
// operationID is the method and the path's words, getModelsNameTarget.
|
||||
func operationID(method, p string) string {
|
||||
func (g *generator) operationID(method, p string) string {
|
||||
var b strings.Builder
|
||||
b.WriteString(strings.ToLower(method))
|
||||
for _, s := range strings.Split(strings.TrimPrefix(p, "/api/v1/"), "/") {
|
||||
for _, s := range strings.Split(strings.TrimPrefix(p, g.d.Prefix), "/") {
|
||||
for _, w := range strings.FieldsFunc(s, func(r rune) bool { return !unicode.IsLetter(r) && !unicode.IsDigit(r) }) {
|
||||
b.WriteString(strings.ToUpper(w[:1]) + w[1:])
|
||||
}
|
||||
@@ -238,8 +313,8 @@ func operationID(method, p string) string {
|
||||
}
|
||||
|
||||
// tagOf groups an operation by the first word of its path.
|
||||
func tagOf(p string) string {
|
||||
first, _, _ := strings.Cut(strings.TrimPrefix(p, "/api/v1/"), "/")
|
||||
func (g *generator) tagOf(p string) string {
|
||||
first, _, _ := strings.Cut(strings.TrimPrefix(strings.TrimPrefix(p, g.d.Prefix), "/"), "/")
|
||||
return strings.TrimSuffix(first, ".json")
|
||||
}
|
||||
|
||||
@@ -256,13 +331,13 @@ type generator struct {
|
||||
names map[reflect.Type]string
|
||||
schemas map[string]any
|
||||
seen []reflect.Type
|
||||
d Doc
|
||||
}
|
||||
|
||||
var (
|
||||
timeType = reflect.TypeOf(time.Time{})
|
||||
durationType = reflect.TypeOf(time.Duration(0))
|
||||
rawType = reflect.TypeOf(json.RawMessage{})
|
||||
errorType = reflect.TypeOf(adminapi.ErrorView{})
|
||||
marshalerType = reflect.TypeOf((*json.Marshaler)(nil)).Elem()
|
||||
textType = reflect.TypeOf((*encoding.TextMarshaler)(nil)).Elem()
|
||||
)
|
||||
@@ -294,7 +369,7 @@ func (g *generator) collect(t reflect.Type) {
|
||||
// modelserve.Job. Qualified always rather than only on a collision, so a
|
||||
// type added elsewhere one day cannot rename a schema clients already use.
|
||||
func (g *generator) assignNames() {
|
||||
own := reflect.TypeOf(adminapi.Route{}).PkgPath()
|
||||
own := g.d.Home
|
||||
for _, t := range g.seen {
|
||||
n := t.Name()
|
||||
if t.PkgPath() != own {
|
||||
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/clientapi"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/control/adminapi"
|
||||
)
|
||||
|
||||
@@ -161,3 +162,39 @@ func TestAPathParameterWithNoDescriptionIsAnError(t *testing.T) {
|
||||
t.Error("a parameter nobody described was let through")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheClientAPIDocumentIsNotStaleAndDescribesWhatClientsSend(t *testing.T) {
|
||||
want, err := GenerateDoc(repoRoot(t), Client, clientapi.Routes, clientapi.PathParams)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
got, err := os.ReadFile(filepath.Join(repoRoot(t), "docs", "client-api.openapi.json"))
|
||||
if err != nil || string(got) != string(want) {
|
||||
t.Fatal("docs/client-api.openapi.json no longer matches the client API's routes and types.\n" +
|
||||
"Run: go generate ./internal/docgen")
|
||||
}
|
||||
var doc map[string]any
|
||||
if err := json.Unmarshal(want, &doc); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
chat := at(t, doc, "paths", "/v1/chat/completions", "post")
|
||||
if at(t, chat, "requestBody", "content", "application/json", "schema", "$ref") != "#/components/schemas/ChatCompletionRequest" {
|
||||
t.Error("chat's body is not its request type")
|
||||
}
|
||||
if _, ok := at(t, chat, "responses", "200", "content").(map[string]any)["text/event-stream"]; !ok {
|
||||
t.Error("chat does not say it may stream")
|
||||
}
|
||||
if _, ok := at(t, doc, "paths", "/v1/files", "post", "requestBody", "content").(map[string]any)["multipart/form-data"]; !ok {
|
||||
t.Error("an upload is not a form")
|
||||
}
|
||||
if at(t, doc, "paths", "/v1/3d/generations", "post", "responses", "202", "description") == nil {
|
||||
t.Error("a 3D job is not answered 202")
|
||||
}
|
||||
if _, ok := at(t, doc, "components", "securitySchemes").(map[string]any)["apiKey"]; !ok {
|
||||
t.Error("no API key scheme")
|
||||
}
|
||||
// The admin API's actor header is the admin API's.
|
||||
if _, ok := at(t, doc, "components").(map[string]any)["parameters"]; ok {
|
||||
t.Error("the client API takes the admin API's X-Llmgw-Actor")
|
||||
}
|
||||
}
|
||||
@@ -70,8 +70,11 @@ var Reference = []Block{
|
||||
{Package: "catalog", Name: "ComfyUI", Title: "ComfyUI", Doc: "", Fields: []Field{
|
||||
{Key: "workflow", Type: "string", Doc: "Workflow is a built-in's name (flux-schnell, the default, or\nflux-dev) or a JSON file on the control plane, in ComfyUI's API\nformat.", Nested: ""},
|
||||
{Key: "checkpoint", Type: "string", Doc: "Checkpoint is the file the workflow's {{checkpoint}} names: the\nsource's own name unless set, which a source that is a set of files\nmust.", Nested: ""},
|
||||
{Key: "output", Type: "string", Doc: "Output is what the workflow makes: pictures (the default), asked for\nat /v1/images/generations, or meshes, asked for as a job at\n/v1/3d/generations from a picture.", Nested: ""},
|
||||
{Key: "output", Type: "string", Doc: "Output is what the workflow makes: pictures (the default), asked for\nat /v1/images/generations; meshes, asked for as a job at\n/v1/3d/generations from a picture; or video, audio or files. Every\nkind is asked for as a job at /v1/workflows/runs too.", Nested: ""},
|
||||
{Key: "inputs", Type: "[]Input", Doc: "Inputs are what the workflow takes from a request at\n/v1/workflows/runs, each the placeholder of its name.", Nested: ""},
|
||||
{Key: "nodes", Type: "[]CustomNode", Doc: "Nodes are custom nodes the workflow needs, put in each replica's own\ncustom_nodes at the commit named.", Nested: ""},
|
||||
{Key: "huggingface_repo", Type: "string", Doc: "HuggingFaceRepo is the repository a custom node loads the weights by\nname from (Stable Fast 3D's loader asks for stabilityai/stable-fast-3d):\nthe replica's weights are shown to the node there, in the Hugging Face\ncache of the engines' user, so nothing is fetched and no token is\nneeded when it runs.", Nested: ""},
|
||||
{Key: "environment", Type: "string", Doc: "Environment names the models that may share one ComfyUI replica: every\nmodel of an environment agrees on the custom nodes they both name, so\none replica can carry all of them and ComfyUI moves between their\nweights itself. Empty is an environment of the model alone.", Nested: ""},
|
||||
}},
|
||||
{Package: "engines", Name: "ComfyUIConfig", Title: "ComfyUIConfig", Doc: "", Fields: []Field{
|
||||
{Key: "dir", Type: "string", Doc: "Dir is ComfyUI's directory, where main.py is. Readable by the user\nengines run as.", Nested: ""},
|
||||
@@ -94,6 +97,7 @@ var Reference = []Block{
|
||||
{Key: "repo", Type: "string", Doc: "Repo is the repository, https only.", Nested: ""},
|
||||
{Key: "commit", Type: "string", Doc: "Commit is the full commit the node is used at: a branch moves, and a\nnode that changed under a model is a model that changed unasked.", Nested: ""},
|
||||
{Key: "requirements", Type: "[]string", Doc: "Requirements are the PyPI packages the node needs, by name and version\nrange only. They are installed beside the replica, never into\nComfyUI's environment: a package named here at the range named, and\nevery other one at the version ComfyUI already runs. One named here\nis first on ComfyUI's path, so its range must suit ComfyUI too.", Nested: ""},
|
||||
{Key: "build", Type: "[]string", Doc: "Build are directories of the repository that are Python packages to\nbe compiled rather than downloaded: C++ and CUDA extensions no index\nhas (Stable Fast 3D's texture_baker and uv_unwrapper). Each is built\nas a wheel with ComfyUI's Python for the card the replica runs on,\nkept on the node for the next replica on the same kind of card, and\ninstalled beside the replica like its requirements.", Nested: ""},
|
||||
}},
|
||||
{Package: "config", Name: "Endpoint", Title: "Endpoint", Doc: "", Fields: []Field{
|
||||
{Key: "id", Type: "string", Doc: "", Nested: ""},
|
||||
@@ -146,10 +150,25 @@ var Reference = []Block{
|
||||
{Package: "config", Name: "FirewallSettings", Title: "FirewallSettings", Doc: "", Fields: []Field{
|
||||
{Key: "enabled", Type: "bool", Doc: "Enabled keeps llmgw's internal ports — engines, node exporter, the\nagents' stream, the mirror, the store — to the cluster's networks on\nevery machine. False removes llmgw's nftables table everywhere, for a\nsite whose own firewall does that job; the rules are kept, and true\nputs them back. Changed in the cluster's settings, it is in force on\nevery node and control plane within seconds.", Nested: ""},
|
||||
}},
|
||||
{Package: "catalog", Name: "GPUNeed", Title: "GPUNeed", Doc: "", Fields: []Field{
|
||||
{Key: "min_compute_capability", Type: "float64", Doc: "MinComputeCapability is the oldest architecture that runs it: 7.5 is\nTuring, 8.0 Ampere (bf16, flash-attention 2), 8.9 Ada (fp8), 9.0 Hopper.", Nested: ""},
|
||||
{Key: "min_memory_gb", Type: "int", Doc: "MinMemoryGB is the card's own memory it needs.", Nested: ""},
|
||||
}},
|
||||
{Package: "catalog", Name: "GuardModel", Title: "GuardModel", Doc: "", Fields: []Field{
|
||||
{Key: "format", Type: "string", Doc: "Format is qwen3guard (Qwen3Guard-Gen: \"Safety: Safe\", \"Unsafe\" or\n\"Controversial\", and the categories), llamaguard3 (Meta's Llama Guard\n3: \"safe\", or \"unsafe\" and the categories), shieldgemma (Google's\nShieldGemma: Yes or No), or json ({\"safe\": false, \"categories\":\n[\"...\"]}).", Nested: ""},
|
||||
{Key: "categories", Type: "[]string", Doc: "Categories the model is asked about, for shieldgemma — each a policy\nsentence — and the names reported for llamaguard3's S1, S2, ….", Nested: ""},
|
||||
}},
|
||||
{Package: "catalog", Name: "Input", Title: "Input", Doc: "", Fields: []Field{
|
||||
{Key: "name", Type: "string", Doc: "Name is the placeholder's, and the request's key.", Nested: ""},
|
||||
{Key: "type", Type: "string", Doc: "Type is one of text, int, float, bool, choice, image, mask, audio,\nvideo, file. The last five are files, sent as base64, a data URL, or\nthe id of a file uploaded to /v1/files, and put in ComfyUI's input\ndirectory; the placeholder gets the name they were given there.", Nested: ""},
|
||||
{Key: "required", Type: "bool", Doc: "Required inputs must be in every request; the others take Default,\nor the workflow's own {{name|default}}.", Nested: ""},
|
||||
{Key: "default", Type: "any", Doc: "", Nested: ""},
|
||||
{Key: "min", Type: "*float64", Doc: "Min and Max bound a number; for text, Max bounds its length.", Nested: ""},
|
||||
{Key: "max", Type: "*float64", Doc: "", Nested: ""},
|
||||
{Key: "choices", Type: "[]string", Doc: "Choices are what a choice may be.", Nested: ""},
|
||||
{Key: "max_mb", Type: "int", Doc: "MaxMB bounds a file input; zero is the type's own bound.", Nested: ""},
|
||||
{Key: "doc", Type: "string", Doc: "Doc says what the input is for, to whoever fills it in.", Nested: ""},
|
||||
}},
|
||||
{Package: "guard", Name: "JudgePolicy", Title: "JudgePolicy", Doc: "", Fields: []Field{
|
||||
{Key: "model", Type: "string", Doc: "Model is a catalog model with role: guard.", Nested: ""},
|
||||
{Key: "models", Type: "[]string", Doc: "Models are judges asked in turn, instead of Model: the first that\nanswers gives the verdict. A judge on a GPU first and one on CPUs\nafter it is the GPU's speed while it is there, and the CPUs' when it\nis not — busy, failed, or the node down.", Nested: ""},
|
||||
@@ -171,9 +190,14 @@ var Reference = []Block{
|
||||
{Key: "docs_sign_in", Type: "bool", Doc: "DocsSignIn serves the docs portal at /docs only to someone signed in.\nOff, the portal is public like this page: its client guide is for the\nperson who has no account yet, and the operator documents describe\nllmgw in general — no address, model or key of this installation —\nwhich the project's repository publishes anyway. On, a visitor is sent\nto sign in, and without accounts the portal needs an API key.", Nested: ""},
|
||||
}},
|
||||
{Package: "catalog", Name: "License", Title: "License", Doc: "", Fields: []Field{
|
||||
{Key: "id", Type: "string", Doc: "ID names the licence for a machine: an SPDX identifier where there is\none (MIT, Apache-2.0, CC-BY-NC-4.0), else a lowercase name of the\nlicence's own (stability-community, tencent-hunyuan-community). What a\nperson's or a site's choice of licences matches on. Name is for people.", Nested: ""},
|
||||
{Key: "name", Type: "string", Doc: "Name is the licence's own: MIT, Apache-2.0.", Nested: ""},
|
||||
{Key: "url", Type: "string", Doc: "", Nested: ""},
|
||||
{Key: "notice", Type: "string", Doc: "Notice is what must accompany what was made: attribution, terms on\nthe output, what the weights were trained on.", Nested: ""},
|
||||
{Key: "commercial", Type: "*bool", Doc: "Commercial says whether what is made may be used commercially: nil\nis not said, which is not the same as yes.", Nested: ""},
|
||||
{Key: "excluded_regions", Type: "[]string", Doc: "ExcludedRegions are where the licence grants nothing: ISO 3166 codes,\nand EU for the union (Hunyuan's: EU, UK, KR).", Nested: ""},
|
||||
{Key: "revenue_cap_usd", Type: "int64", Doc: "RevenueCapUSD is the yearly revenue above which the licence asks for\nanother agreement (Stability's community licence: 1000000). Zero is\nnone.", Nested: ""},
|
||||
{Key: "attribution", Type: "string", Doc: "Attribution is what a product using the output must show: \"Powered by\nStability AI\".", Nested: ""},
|
||||
}},
|
||||
{Package: "engines", Name: "LlamaCppConfig", Title: "LlamaCppConfig", Doc: "", Fields: []Field{
|
||||
{Key: "bin", Type: "string", Doc: "Bin is the llama-server binary. It is the server, not the CLI: the\ngateway talks OpenAI over HTTP and needs the one that serves it.\nEmpty means the agent installs llama.cpp itself, at the version the\ncontrol plane asks for. Setting it opts out of that.", Nested: ""},
|
||||
@@ -236,6 +260,10 @@ var Reference = []Block{
|
||||
{Key: "mirror", Type: "string", Doc: "Mirror is the mirror's file address, as nodes reach it:\nhttp://10.0.0.5:8081 — the port model files are served on, not the\nmanagement API. Set, the cluster is offline: nodes install engines\nfrom it and never from their publishers, releases come from it unless\nreleases names another place, and no registry is asked whether a\nmodel has newer weights. Python engines (vLLM, SGLang) come from PyPI,\nwhich no bundle carries; on an offline node they are installed by hand.", Nested: ""},
|
||||
{Key: "checksums", Type: "string", Doc: "Checksums is the file of engine checksums this control plane trusts,\nkept by llmgw bundle import and llmgw bundle trust; every engine file\na node fetches from the mirror is checked against it. Read again\nwhenever it changes. Empty is /etc/llmgw/offline.sha256.", Nested: ""},
|
||||
}},
|
||||
{Package: "config", Name: "OnDemandSettings", Title: "OnDemandSettings", Doc: "", Fields: []Field{
|
||||
{Key: "evict_after_idle", Type: "time.Duration", Doc: "EvictAfterIdle is how long an on-demand replica must go unasked-for\nbefore a model that wants its card may have it. Zero keeps 2m.", Nested: ""},
|
||||
{Key: "min_lifetime", Type: "time.Duration", Doc: "MinLifetime is how long a replica that has just come up is safe from\nthat, so two models do not take turns paying for loads. Zero keeps\n5m. On one card shared by a picture model and a 3D model, 1m each\nbrings the wait between a picture and its mesh to about a minute.\nBoth are in force on the leader within seconds.", Nested: ""},
|
||||
}},
|
||||
{Package: "discovery", Name: "Options", Title: "Options", Doc: "", Fields: []Field{
|
||||
{Key: "nvidia_smi", Type: "string", Doc: "NvidiaSMI is the path to nvidia-smi; empty means look it up on PATH.\nWorth configuring on nodes where the driver lives outside the default\npaths, which containerized driver installs often do.", Nested: ""},
|
||||
{Key: "ib_root", Type: "string", Doc: "IBRoot is the sysfs InfiniBand directory.", Nested: ""},
|
||||
@@ -289,6 +317,9 @@ var Reference = []Block{
|
||||
{Key: "balance_abs", Type: "float64", Doc: "", Nested: ""},
|
||||
{Key: "balance_rel", Type: "float64", Doc: "", Nested: ""},
|
||||
}},
|
||||
{Package: "config", Name: "PresetSettings", Title: "PresetSettings", Doc: "", Fields: []Field{
|
||||
{Key: "auto", Type: "bool", Doc: "Auto has the leading control plane add a picture model (flux-schnell)\nand a 3D model (triposr) by itself, on demand, once a node has a card\nthat fits one and the catalog has no model that makes the same kind of\nthing — so a new cluster's portal has its pictures and 3D pages\nwithout anybody writing a definition. Only where the cluster already\ninstalls ComfyUI (engines.comfyui). A preset somebody removed is not\nadded again by itself. In force on the leader within a minute.", Nested: ""},
|
||||
}},
|
||||
{Package: "catalog", Name: "PreviousOrigin", Title: "PreviousOrigin", Doc: "", Fields: []Field{
|
||||
{Key: "source", Type: "string", Doc: "", Nested: ""},
|
||||
{Key: "revision", Type: "string", Doc: "", Nested: ""},
|
||||
@@ -316,6 +347,13 @@ var Reference = []Block{
|
||||
{Key: "priority", Type: "int", Doc: "Priority orders profiles during placement; highest that fits wins.", Nested: ""},
|
||||
{Key: "startup_timeout", Type: "time.Duration", Doc: "StartupTimeout bounds model loading. A 70B model across two nodes takes\ntens of minutes, so this is per profile rather than global.", Nested: ""},
|
||||
{Key: "kv_events", Type: "bool", Doc: "KVEvents has vLLM publish what its prefix cache holds, and the router\nroute this model's requests by it: to the replica holding the most of\na prompt's leading blocks (plan §7.5 tier 2). vLLM only.\n\nOff by default, because it costs something on every request: the\nrouter asks a replica to tokenize the prompt before placing it, a\nround trip and the chat template run twice. It pays where prompts\nshare long prefixes that the approximate tree guesses wrong — many\nreplicas, conversations that move between them, evictions. The engine\nis started with sha256_cbor block hashing and a fixed PYTHONHASHSEED,\nwhich the router's hashing assumes; arguments overriding either leave\nthe index empty, and the agent says so in its log.", Nested: ""},
|
||||
{Key: "gpu", Type: "*GPUNeed", Doc: "GPU says what card the profile needs, in place of naming its class:\nit stands for every class in the cluster that meets it. A catalog\nentry written once then places sensibly on any site's cards.", Nested: "catalog.GPUNeed"},
|
||||
{Key: "comfyui", Type: "*ProfileComfyUI", Doc: "ComfyUI is this profile's own workflow, checkpoint and nodes, over the\nmodel's: an fp8 workflow where the card has fp8, fp16 where it has not.", Nested: "catalog.ProfileComfyUI"},
|
||||
}},
|
||||
{Package: "catalog", Name: "ProfileComfyUI", Title: "ProfileComfyUI", Doc: "", Fields: []Field{
|
||||
{Key: "workflow", Type: "string", Doc: "", Nested: ""},
|
||||
{Key: "checkpoint", Type: "string", Doc: "", Nested: ""},
|
||||
{Key: "nodes", Type: "[]CustomNode", Doc: "", Nested: ""},
|
||||
}},
|
||||
{Package: "config", Name: "Router", Title: "Router", Doc: "", Fields: []Field{
|
||||
{Key: "activation_wait", Type: "time.Duration", Doc: "ActivationWait is how long a request waits for an on-demand model to\nload before the client is told to come back. Zero takes the default.\n\nThe one real decision in on-demand loading. Refusing outright makes the\nfeature useless, since the first request for every model would fail;\nwaiting without a bound turns a request into a job, and a client that\nbudgeted thirty seconds ends up holding a connection for ten minutes.", Nested: ""},
|
||||
@@ -407,6 +445,8 @@ var Reference = []Block{
|
||||
{Key: "mail", Type: "mail.Config", Doc: "Mail is where the gateway's few emails go out from: a link to set a\nforgotten password. Unset, none is sent and people ask an operator.", Nested: "mail.Config"},
|
||||
{Key: "serving", Type: "ServingSettings", Doc: "Serving stops and starts the whole cluster's service (llmgw stop, llmgw\nstart).", Nested: "config.ServingSettings"},
|
||||
{Key: "firewall", Type: "FirewallSettings", Doc: "Firewall turns llmgw's firewall on every machine on or off.", Nested: "config.FirewallSettings"},
|
||||
{Key: "presets", Type: "PresetSettings", Doc: "Presets is how the models that come with llmgw reach the catalog.", Nested: "config.PresetSettings"},
|
||||
{Key: "on_demand", Type: "OnDemandSettings", Doc: "OnDemand is how models that load when asked for take turns on the\ncards.", Nested: "config.OnDemandSettings"},
|
||||
{Key: "agents", Type: "AgentSettings", Doc: "Agents are the nodes' agent settings: agent.yaml's keys but those an\nagent needs to start, for every node (default) and for one\n(nodes.<id>). Sent to the agents as they change; an agent whose\nsettings changed starts again on them, its engines serving\nthroughout.", Nested: "config.AgentSettings"},
|
||||
{Key: "firewall_networks", Type: "[]string", Doc: "FirewallNetworks are networks, besides those each machine reaches the\ncluster on, that llmgw's internal ports answer: a monitoring host on\nanother subnet, nodes behind a router. Written into every machine's\nfirewall by `server init`, `node add` and `server add`.", Nested: ""},
|
||||
{Key: "backup_recipients", Type: "[]string", Doc: "BackupRecipients encrypt every archive `llmgw server backup` writes, to\nwhoever holds one of their keys: age recipients (age1…) or SSH public\nkeys (ssh-ed25519 …, ssh-rsa …), as `age` takes them. An archive holds\nthe certificate authority's key and every secret in the store, and is\ncopied off the machine; encrypted, the copy is safe wherever it lands.\nEmpty writes archives unencrypted, readable by root only.", Nested: ""},
|
||||
|
||||
@@ -26,6 +26,8 @@ var Sources = []string{
|
||||
"internal/agent/supervisor/supervisor.go",
|
||||
"internal/tlsconf/tlsconf.go",
|
||||
"internal/control/catalog/catalog.go",
|
||||
"internal/control/catalog/workflow.go",
|
||||
"internal/control/catalog/hardware.go",
|
||||
"internal/router/admission/controller.go",
|
||||
"internal/accounting/cost.go",
|
||||
"internal/guard/policy.go",
|
||||
@@ -33,6 +35,8 @@ var Sources = []string{
|
||||
"internal/config/oidc.go",
|
||||
"internal/config/firewall.go",
|
||||
"internal/config/serving.go",
|
||||
"internal/config/presets.go",
|
||||
"internal/config/ondemand.go",
|
||||
"internal/config/agents.go",
|
||||
"internal/mail/mail.go",
|
||||
"internal/notify/notify.go",
|
||||
|
||||
@@ -41,6 +41,10 @@ type Header struct {
|
||||
// them; otherwise a head is EmbeddingLength / HeadCount.
|
||||
KeyLength uint64
|
||||
ValueLength uint64
|
||||
// Embedding is whether the model pools its tokens into one vector
|
||||
// (<arch>.pooling_type set and not none): an embedding model, which
|
||||
// llama.cpp serves with --embedding and does not chat.
|
||||
Embedding bool
|
||||
}
|
||||
|
||||
// KVBytesPerToken is what one token of context costs in llama.cpp's default
|
||||
@@ -265,6 +269,8 @@ func Read(r io.Reader) (Header, error) {
|
||||
h.KeyLength = num
|
||||
case "attention.value_length":
|
||||
h.ValueLength = num
|
||||
case "pooling_type":
|
||||
h.Embedding = num > 0
|
||||
}
|
||||
}
|
||||
// The tokenizer's arrays — megabytes of vocabulary — come after the
|
||||
@@ -372,3 +378,40 @@ func Check(ctx context.Context, url, llamaVersion string) Verdict {
|
||||
v.Header = h
|
||||
return v
|
||||
}
|
||||
|
||||
// CardUsable is the share of a card's memory a model may take: the rest is
|
||||
// CUDA's own and the engine's compute buffers.
|
||||
const CardUsable = 0.9
|
||||
|
||||
// PoolThatFits is the largest context pool, in tokens, whose KV cache fits
|
||||
// on gpus cards of cardGB beside weights bytes of weights and a gigabyte for
|
||||
// the engine: -1 when the weights alone do not, 0 when the header or the
|
||||
// card does not say enough to tell.
|
||||
func (h Header) PoolThatFits(weights int64, cardGB, gpus int) int {
|
||||
perTok := h.KVBytesPerToken()
|
||||
if cardGB <= 0 || perTok <= 0 || weights <= 0 {
|
||||
return 0
|
||||
}
|
||||
budget := float64(cardGB*max(gpus, 1))*CardUsable*(1<<30) - float64(weights) - (1 << 30)
|
||||
if budget <= 0 {
|
||||
return -1
|
||||
}
|
||||
return int(budget / float64(perTok))
|
||||
}
|
||||
|
||||
// ClassMemGB is a card's memory as its class names it: 6000-24g is 24, 0
|
||||
// for a class that does not say.
|
||||
func ClassMemGB(class string) int {
|
||||
i := strings.LastIndex(class, "-")
|
||||
if i < 0 || !strings.HasSuffix(class, "g") {
|
||||
return 0
|
||||
}
|
||||
n := 0
|
||||
for _, c := range strings.TrimSuffix(class[i+1:], "g") {
|
||||
if c < '0' || c > '9' {
|
||||
return 0
|
||||
}
|
||||
n = n*10 + int(c-'0')
|
||||
}
|
||||
return n
|
||||
}
|
||||
@@ -163,3 +163,50 @@ func TestArraysNestedDeepAreRefused(t *testing.T) {
|
||||
t.Errorf("ten thousand nested arrays: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnEmbeddingModelIsKnownByItsPooling(t *testing.T) {
|
||||
build := func(pooling uint32) []byte {
|
||||
var b bytes.Buffer
|
||||
w := func(v any) { _ = binary.Write(&b, binary.LittleEndian, v) }
|
||||
str := func(s string) { w(uint64(len(s))); b.WriteString(s) }
|
||||
u32 := func(k string, v uint32) { str(k); w(uint32(tUint32)); w(v) }
|
||||
b.WriteString("GGUF")
|
||||
w(uint32(3))
|
||||
w(uint64(0))
|
||||
w(uint64(3))
|
||||
str("general.architecture")
|
||||
w(uint32(tString))
|
||||
str("bert")
|
||||
u32("bert.block_count", 24)
|
||||
u32("bert.pooling_type", pooling)
|
||||
return b.Bytes()
|
||||
}
|
||||
if h, err := Read(bytes.NewReader(build(2))); err != nil || !h.Embedding {
|
||||
t.Errorf("CLS pooling: %+v %v", h, err)
|
||||
}
|
||||
if h, err := Read(bytes.NewReader(build(0))); err != nil || h.Embedding {
|
||||
t.Errorf("no pooling: %+v %v", h, err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPoolIsSizedToTheCard(t *testing.T) {
|
||||
// Apertus-8B's shape: 32 layers, 8 KV heads of 128, 128 KiB a token.
|
||||
h, err := Read(bytes.NewReader(shapedHeader("apertus", 32, 32, 8, 4096, true)))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
weights := int64(8.5 * (1 << 30))
|
||||
most := h.PoolThatFits(weights, ClassMemGB("6000-24g"), 1)
|
||||
if most < 90000 || most > 105000 {
|
||||
t.Errorf("an 8B on 24 GB holds %d tokens of pool", most)
|
||||
}
|
||||
if most >= 131072 {
|
||||
t.Error("the 131072 pool that failed on the card would pass")
|
||||
}
|
||||
if got := h.PoolThatFits(int64(30*(1<<30)), 24, 1); got != -1 {
|
||||
t.Errorf("30 GB of weights on 24 GB: %d", got)
|
||||
}
|
||||
if ClassMemGB("t4-15g") != 15 || ClassMemGB("cpu") != 0 || ClassMemGB("v100-32g") != 32 {
|
||||
t.Error("class memory misread")
|
||||
}
|
||||
}
|
||||
@@ -258,7 +258,11 @@ type Result struct {
|
||||
|
||||
// redact keeps a webhook's host and drops its path, where Slack and others
|
||||
// put the secret.
|
||||
func redact(u string) string {
|
||||
func redact(u string) string { return Redact(u) }
|
||||
|
||||
// Redact is a webhook's address as it may be shown: its host, not the path
|
||||
// that is its secret.
|
||||
func Redact(u string) string {
|
||||
if i := strings.Index(u, "://"); i >= 0 {
|
||||
if j := strings.IndexByte(u[i+3:], '/'); j >= 0 {
|
||||
return u[:i+3+j] + "/…"
|
||||
|
||||
@@ -2,6 +2,7 @@ package router
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/notify"
|
||||
@@ -26,6 +27,40 @@ type unservable interface {
|
||||
Unservable(model string) (string, bool)
|
||||
}
|
||||
|
||||
// waiter is an activator that can say which model holds the cards an
|
||||
// on-demand one waits for, and about how long the wait is.
|
||||
type waiter interface {
|
||||
WaitFor(model string) (heldBy string, eta time.Duration, ok bool)
|
||||
}
|
||||
|
||||
// waitingErr is errLoading for a model waiting on another to give up its
|
||||
// cards: who holds them, and the wait when it can be told.
|
||||
type waitingErr struct {
|
||||
heldBy string
|
||||
eta time.Duration
|
||||
}
|
||||
|
||||
func (e *waitingErr) Error() string {
|
||||
if e.eta > 0 {
|
||||
return fmt.Sprintf("%s: waiting for %s to give up the GPU; expected in about %d s",
|
||||
errLoading, e.heldBy, int(e.eta.Seconds()))
|
||||
}
|
||||
return fmt.Sprintf("%s: waiting for %s to give up the GPU", errLoading, e.heldBy)
|
||||
}
|
||||
|
||||
func (e *waitingErr) Unwrap() error { return errLoading }
|
||||
|
||||
// loadingErr is why a wanted model is not serving yet: waiting on another
|
||||
// model's cards when the activator can say so, else simply loading.
|
||||
func (r *Router) loadingErr(model string) error {
|
||||
if w, ok := r.activator.(waiter); ok {
|
||||
if by, eta, waiting := w.WaitFor(model); waiting {
|
||||
return &waitingErr{heldBy: by, eta: eta}
|
||||
}
|
||||
}
|
||||
return fmt.Errorf("%w: %s", errLoading, "the model is loading; retry shortly")
|
||||
}
|
||||
|
||||
// whyUnservable is the activator's reason a model cannot be served, if any.
|
||||
func (r *Router) whyUnservable(model string) (string, bool) {
|
||||
u, ok := r.activator.(unservable)
|
||||
|
||||
@@ -39,7 +39,7 @@ func (r *Router) runBatches(ctx context.Context) {
|
||||
t := time.NewTicker(batchPoll)
|
||||
defer t.Stop()
|
||||
for {
|
||||
for {
|
||||
for r.leading() {
|
||||
now := time.Now()
|
||||
b, ok, err := r.store.ClaimBatch(ctx, owner, now, now.Add(batchLease))
|
||||
if err != nil {
|
||||
|
||||
@@ -111,7 +111,7 @@ func (r *Router) isCanaryTarget(name string) bool {
|
||||
|
||||
// hiddenModel is a model clients cannot name: a judge, or a canary.
|
||||
func (r *Router) hiddenModel(name string) bool {
|
||||
return r.isGuardModel(name) || r.isCanaryTarget(name)
|
||||
return r.isGuardModel(name) || r.isCanaryTarget(name) || r.modelMap()[name].IsEnvironment()
|
||||
}
|
||||
|
||||
// setVariantHeader tells the client which side served it.
|
||||
|
||||
@@ -58,6 +58,9 @@ func (r *Router) registerChat(mux *http.ServeMux, pages *web.AccountPages) {
|
||||
}))
|
||||
r.registerImagesPage(mux, pages)
|
||||
r.registerMeshesPage(mux, pages)
|
||||
if r.store != nil {
|
||||
pages.SetLicences(r.licenceChoices, r.store)
|
||||
}
|
||||
}
|
||||
|
||||
// chatSend dispatches one turn on behalf of a signed-in person.
|
||||
|
||||
@@ -103,3 +103,21 @@ func TestStructuredContentIsCounted(t *testing.T) {
|
||||
t.Errorf("structured content counted as %d bytes", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPictureIsCountedAsWhatAModelMakesOfItNotItsBase64(t *testing.T) {
|
||||
// A 1280x720 PNG was counted as 138 thousand tokens of base64 and an 8k
|
||||
// vision model refused it; its projector makes about a thousand of it.
|
||||
pic := `{"type":"image_url","image_url":{"url":"data:image/png;base64,` + strings.Repeat("A", 550_000) + `"}}`
|
||||
b := &inferenceBody{Messages: []struct {
|
||||
Role string `json:"role"`
|
||||
Content json.RawMessage `json:"content"`
|
||||
}{{Role: "user", Content: json.RawMessage(`[{"type":"text","text":"check it"},` + pic + `,` + pic + `]`)}}}
|
||||
got := promptBytes(b) / 4
|
||||
if got < 2000 || got > 2200 {
|
||||
t.Errorf("two pictures and a line estimated as %d tokens", got)
|
||||
}
|
||||
m := catalog.Model{Name: "vlm", ContextLength: 8192}
|
||||
if why := checkContextFits(m, got, 300); why != "" {
|
||||
t.Errorf("refused: %s", why)
|
||||
}
|
||||
}
|
||||
@@ -51,6 +51,25 @@ type Info struct {
|
||||
// Workflow is the ComfyUI workflow sent for an endpoint whose engine is
|
||||
// EngineComfyUI: a built-in's name or the workflow's JSON.
|
||||
Workflow string
|
||||
// Comfy is, for a shared ComfyUI replica that answers for several
|
||||
// models, each one's workflow and checkpoint, by every name it goes by.
|
||||
// Nil for a replica of one model, which Workflow and UpstreamModel say.
|
||||
Comfy map[string]ComfyRoute
|
||||
}
|
||||
|
||||
// ComfyRoute is what a request for one model of a shared ComfyUI replica is
|
||||
// sent.
|
||||
type ComfyRoute struct {
|
||||
Workflow string
|
||||
Checkpoint string
|
||||
}
|
||||
|
||||
// ComfyFor is the workflow and checkpoint a request for model is sent here.
|
||||
func (i Info) ComfyFor(model string) (workflow, checkpoint string) {
|
||||
if r, ok := i.Comfy[model]; ok {
|
||||
return r.Workflow, r.Checkpoint
|
||||
}
|
||||
return i.Workflow, i.UpstreamModel
|
||||
}
|
||||
|
||||
// EngineExternal marks an endpoint that is a provider outside the cluster.
|
||||
|
||||
@@ -7,6 +7,7 @@ import (
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"slices"
|
||||
"time"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/auth"
|
||||
@@ -20,8 +21,16 @@ import (
|
||||
const (
|
||||
purposeBatch = "batch"
|
||||
purposeBatchOutput = "batch_output"
|
||||
// purposeVision and purposeUserData are files a request works from — a
|
||||
// picture to make a mesh of or to look at, a workflow's input — named
|
||||
// by id rather than sent as base64 in every call. OpenAI's names.
|
||||
purposeVision = "vision"
|
||||
purposeUserData = "user_data"
|
||||
)
|
||||
|
||||
// uploadPurposes are what a client may upload a file for.
|
||||
var uploadPurposes = []string{purposeBatch, purposeVision, purposeUserData}
|
||||
|
||||
func newID(prefix string) string {
|
||||
var b [12]byte
|
||||
_, _ = rand.Read(b[:])
|
||||
@@ -99,9 +108,11 @@ func (r *Router) handleUploadFile(w http.ResponseWriter, req *http.Request) {
|
||||
fmt.Sprintf("a multipart form with purpose and file, at most %d MB: %v", maxBytes>>20, err))
|
||||
return
|
||||
}
|
||||
if purpose := req.FormValue("purpose"); purpose != purposeBatch {
|
||||
purpose := req.FormValue("purpose")
|
||||
if !slices.Contains(uploadPurposes, purpose) {
|
||||
writeError(w, http.StatusBadRequest, "invalid_request_error",
|
||||
fmt.Sprintf("purpose %q: this gateway keeps files for batches only (purpose batch)", purpose))
|
||||
fmt.Sprintf("purpose %q: this gateway keeps files for batches (batch) and for requests to work from "+
|
||||
"(vision, user_data)", purpose))
|
||||
return
|
||||
}
|
||||
file, header, err := req.FormFile("file")
|
||||
@@ -120,8 +131,13 @@ func (r *Router) handleUploadFile(w http.ResponseWriter, req *http.Request) {
|
||||
fmt.Sprintf("the file is larger than %d MB", maxBytes>>20))
|
||||
return
|
||||
}
|
||||
f := store.File{ID: newID("file-"), Owner: ownerOf(p), Purpose: purposeBatch,
|
||||
f := store.File{ID: newID("file-"), Owner: ownerOf(p), Purpose: purpose,
|
||||
Filename: header.Filename, Bytes: int64(len(content)), CreatedAt: time.Now()}
|
||||
// A file to work from is kept as long as what is made from it.
|
||||
if purpose != purposeBatch {
|
||||
_, _, _, days := r.batchCfg()
|
||||
f.ExpiresAt = f.CreatedAt.AddDate(0, 0, days)
|
||||
}
|
||||
if err := r.store.PutFile(req.Context(), f, content); err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "server_error", err.Error())
|
||||
return
|
||||
|
||||
+125
-8
@@ -8,7 +8,9 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
llmgw "gitea.mynodes.xyz/ilker/llmgw"
|
||||
"io"
|
||||
"maps"
|
||||
"net/http"
|
||||
"slices"
|
||||
"strconv"
|
||||
@@ -119,6 +121,12 @@ func (r *Router) Handler() http.Handler {
|
||||
mux.HandleFunc("POST /v1/messages", r.handleMessages)
|
||||
mux.HandleFunc("POST /v1/messages/count_tokens", r.handleCountTokens)
|
||||
mux.HandleFunc("GET /v1/models", r.handleModels)
|
||||
// The API described, for SDK generators and the portal's reference.
|
||||
// Not secret, and asked for before a key is in hand: no key needed.
|
||||
mux.HandleFunc("GET /v1/openapi.json", func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(llmgw.ClientOpenAPI)
|
||||
})
|
||||
// Files and batches: a file of requests served at the lowest priority.
|
||||
mux.HandleFunc("POST /v1/files", r.handleUploadFile)
|
||||
mux.HandleFunc("GET /v1/files", r.handleListFiles)
|
||||
@@ -135,6 +143,12 @@ func (r *Router) Handler() http.Handler {
|
||||
mux.HandleFunc("GET "+meshesPath, r.handleListJobs)
|
||||
mux.HandleFunc("GET "+meshesPath+"/{id}", r.handleGetJob)
|
||||
mux.HandleFunc("POST "+meshesPath+"/{id}/cancel", r.handleCancelJob)
|
||||
// Workflow runs: whatever a ComfyUI model makes, from the inputs its
|
||||
// catalog entry declares, as a job like a 3D model.
|
||||
mux.HandleFunc("POST "+workflowsPath, r.createJobAt(workflowsPath))
|
||||
mux.HandleFunc("GET "+workflowsPath, r.handleListJobs)
|
||||
mux.HandleFunc("GET "+workflowsPath+"/{id}", r.handleGetJob)
|
||||
mux.HandleFunc("POST "+workflowsPath+"/{id}/cancel", r.handleCancelJob)
|
||||
// Knowledge bases: documents a person's llmgw-kb read and embedded.
|
||||
r.registerKB(mux)
|
||||
// Liveness: this process is up. It says nothing about whether it can
|
||||
@@ -270,6 +284,17 @@ func (r *Router) Handler() http.Handler {
|
||||
docs := pages.DocsPage(web.Docs(version.Version, true), r.landing.DocsSignIn)
|
||||
mux.HandleFunc("GET /docs", docs)
|
||||
mux.HandleFunc("GET /docs/{doc}", docs)
|
||||
// The APIs' reference, in Swagger UI: the client API's document to
|
||||
// whoever may read the docs, the admin API's to staff.
|
||||
mux.HandleFunc("GET /docs/api", pages.DocsPage(web.APIDocs(version.Version, true), r.landing.DocsSignIn))
|
||||
mux.HandleFunc("GET /docs/api/admin.json", pages.Guard(func(w http.ResponseWriter, req *http.Request, user store.User) {
|
||||
if !user.Staff() {
|
||||
http.NotFound(w, req)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(llmgw.AdminOpenAPI)
|
||||
}))
|
||||
r.registerChat(mux, pages)
|
||||
// An organization's own page, for the people who manage it.
|
||||
pages.RegisterOrgPages(mux, r.store, r.acct)
|
||||
@@ -304,6 +329,10 @@ func (r *Router) Handler() http.Handler {
|
||||
if e, ok := r.clusterView.(web.NodeEngineAdmin); ok {
|
||||
pages.RegisterNodeEngines(mux, e)
|
||||
}
|
||||
// The models that come with llmgw, added from the same page.
|
||||
if a, ok := r.clusterView.(web.PresetAdmin); ok {
|
||||
pages.RegisterPresets(mux, a)
|
||||
}
|
||||
pages.RegisterAdminQuotas(mux, r.store, r.acct)
|
||||
// And the report of what that tree actually used.
|
||||
if r.history != nil {
|
||||
@@ -326,12 +355,15 @@ func (r *Router) Handler() http.Handler {
|
||||
docs := web.Docs(version.Version, false)
|
||||
mux.HandleFunc("GET /docs", docs)
|
||||
mux.HandleFunc("GET /docs/{doc}", docs)
|
||||
mux.HandleFunc("GET /docs/api", web.APIDocs(version.Version, false))
|
||||
}
|
||||
|
||||
if r.auth == nil {
|
||||
return r.refuseWhileStopped(r.refuseLoops(mux))
|
||||
h := r.refuseWhileStopped(r.refuseLoops(mux))
|
||||
r.selfHandler.Store(&h)
|
||||
return h
|
||||
}
|
||||
exempt := []string{"/health", "/ready", "/leader", "/", "/about", "/_static/", "/_lang/", "/claim/",
|
||||
exempt := []string{"/health", "/ready", "/leader", "/v1/openapi.json", "/", "/about", "/_static/", "/_lang/", "/claim/",
|
||||
"/signup", "/login", "/login/", "/logout", "/profile", "/profile/", "/scim/",
|
||||
"/admin", "/admin/", "/chat", "/chat/", "/images", "/images/", "/3d", "/3d/", "/org", "/org/", "/setup/"}
|
||||
// The docs are public unless the site said otherwise, and then guarded by
|
||||
@@ -343,7 +375,9 @@ func (r *Router) Handler() http.Handler {
|
||||
// Wrapping the whole mux rather than checking inside each handler: adding a
|
||||
// route must not be able to add an unauthenticated one by omission. Health
|
||||
// stays open because a load balancer has no key.
|
||||
return r.refuseWhileStopped(r.refuseLoops(auth.Middleware(r.auth, r.log, exempt...)(mux)))
|
||||
h := r.refuseWhileStopped(r.refuseLoops(auth.Middleware(r.auth, r.log, exempt...)(mux)))
|
||||
r.selfHandler.Store(&h)
|
||||
return h
|
||||
}
|
||||
|
||||
// refuseWhileStopped answers every request for a model with 503 while the
|
||||
@@ -520,7 +554,7 @@ func (r *Router) handleInference(path string) http.HandlerFunc {
|
||||
}
|
||||
if p, ok := auth.FromContext(req.Context()); ok {
|
||||
if !r.permits(p, parsed.Model) {
|
||||
auth.WriteForbiddenModel(w, parsed.Model)
|
||||
r.writeForbidden(w, p, parsed.Model)
|
||||
r.m.observeRequest(r.metricModel(parsed.Model), "", http.StatusForbidden, time.Since(start), nil, 0)
|
||||
return
|
||||
}
|
||||
@@ -676,6 +710,11 @@ func (r *Router) permits(p auth.Principal, requested string) bool {
|
||||
return true
|
||||
}
|
||||
canonical, m := r.resolve(requested)
|
||||
// A licence the person has said not to use leaves the model out
|
||||
// whatever the allowlist says: it is theirs to narrow, not to widen.
|
||||
if licenceExcluded(p.Limits.ExcludedLicences, m) != "" {
|
||||
return false
|
||||
}
|
||||
if p.Allows(canonical) {
|
||||
return true
|
||||
}
|
||||
@@ -710,7 +749,19 @@ func (r *Router) finish(w http.ResponseWriter, req *parsedRequest, res dispatchR
|
||||
// is told so will make it. Without the header a well-behaved client
|
||||
// backs off exactly as it would from a permanent failure.
|
||||
status = http.StatusServiceUnavailable
|
||||
w.Header().Set("Retry-After", "30")
|
||||
retry := 30
|
||||
// Waiting on another model's cards: who holds them and for about
|
||||
// how long, which a job keeps as its progress.
|
||||
var we *waitingErr
|
||||
if errors.As(res.err, &we) {
|
||||
w.Header().Set(waitingForHeader, we.heldBy)
|
||||
if we.eta > 0 {
|
||||
secs := int(we.eta.Seconds())
|
||||
w.Header().Set(etaHeader, strconv.Itoa(secs))
|
||||
retry = min(max(secs, 5), retry)
|
||||
}
|
||||
}
|
||||
w.Header().Set("Retry-After", strconv.Itoa(retry))
|
||||
writeError(w, status, "server_error", res.err.Error())
|
||||
case errors.Is(res.err, errNoCapacity):
|
||||
status = http.StatusServiceUnavailable
|
||||
@@ -954,6 +1005,23 @@ func (p *parsedRequest) contextTokens() int {
|
||||
return p.PromptTokens
|
||||
}
|
||||
|
||||
// mediaPartBytes is what one picture or sound in a prompt is counted as,
|
||||
// in the bytes-over-four estimate: a thousand tokens, about what a vision
|
||||
// model's projector makes of a 1280x720 picture. Engines differ, and a large
|
||||
// picture can be more; the estimate errs low, as it does for text, and the
|
||||
// engine has the last word.
|
||||
const mediaPartBytes = 1024 * 4
|
||||
|
||||
// promptBytesOf is promptBytes of a request body; the body's length when it
|
||||
// cannot be read as one.
|
||||
func promptBytesOf(body []byte) int {
|
||||
var b inferenceBody
|
||||
if err := json.Unmarshal(body, &b); err != nil {
|
||||
return len(body)
|
||||
}
|
||||
return promptBytes(&b)
|
||||
}
|
||||
|
||||
func promptBytes(b *inferenceBody) int {
|
||||
n := 0
|
||||
add := func(raw json.RawMessage) {
|
||||
@@ -965,9 +1033,31 @@ func promptBytes(b *inferenceBody) int {
|
||||
n += len(str)
|
||||
return
|
||||
}
|
||||
// Not a plain string: structured content, an array of parts, an image.
|
||||
// The raw JSON overstates the text slightly, which is the safe
|
||||
// direction for a limit.
|
||||
// An array of parts: text by its text, a picture or a sound by
|
||||
// what an engine makes of one. Counted as raw JSON, a 1280x720 PNG
|
||||
// was 138 thousand "tokens" of base64 and refused by an 8k model
|
||||
// that takes it as about one thousand.
|
||||
var parts []map[string]json.RawMessage
|
||||
if err := json.Unmarshal(raw, &parts); err == nil {
|
||||
for _, part := range parts {
|
||||
var typ string
|
||||
_ = json.Unmarshal(part["type"], &typ)
|
||||
switch typ {
|
||||
case "text", "input_text":
|
||||
var t string
|
||||
_ = json.Unmarshal(part["text"], &t)
|
||||
n += len(t)
|
||||
case "image_url", "input_image", "image", "input_audio":
|
||||
n += mediaPartBytes
|
||||
default:
|
||||
b, _ := json.Marshal(part)
|
||||
n += len(b)
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
// Anything else structured: the raw JSON overstates the text
|
||||
// slightly, which is the safe direction for a limit.
|
||||
n += len(raw)
|
||||
}
|
||||
for _, m := range b.Messages {
|
||||
@@ -1089,6 +1179,16 @@ func (r *Router) handleModels(w http.ResponseWriter, req *http.Request) {
|
||||
seen[m] = struct{}{}
|
||||
}
|
||||
}
|
||||
// A model that loads when asked has no replica until somebody asks,
|
||||
// and asking is how it gets one: listing only what runs hid it from
|
||||
// exactly the clients that would have asked — a 3D model, a picture
|
||||
// model, asleep between uses. Said with loaded: false.
|
||||
loaded := maps.Clone(seen)
|
||||
for name, m := range r.modelMap() {
|
||||
if name == m.Name && m.Scaling.OnDemand() && !m.IsExternal() {
|
||||
seen[name] = struct{}{}
|
||||
}
|
||||
}
|
||||
// Catalog aliases are usable names too, so clients should see them.
|
||||
for name := range r.modelMap() {
|
||||
if _, ok := seen[r.modelMap()[name].Name]; ok {
|
||||
@@ -1116,8 +1216,15 @@ func (r *Router) handleModels(w http.ResponseWriter, req *http.Request) {
|
||||
if r.modelMap()[n].Simulated() {
|
||||
owner = "llmgw-sim"
|
||||
}
|
||||
_, up := loaded[n]
|
||||
if m := r.modelMap()[n]; !up && m.Name != "" {
|
||||
_, up = loaded[m.Name]
|
||||
}
|
||||
entry := map[string]any{
|
||||
"id": n, "object": "model", "created": time.Now().Unix(), "owned_by": owner,
|
||||
// Not OpenAI's: whether a replica is up now, or the first
|
||||
// request waits for one to load.
|
||||
"loaded": up,
|
||||
}
|
||||
// Not OpenAI's either: what a federated peer reading this list needs
|
||||
// to leave out — a second name for a model already listed, and a
|
||||
@@ -1149,6 +1256,16 @@ func (r *Router) handleModels(w http.ResponseWriter, req *http.Request) {
|
||||
entry["capabilities"] = map[string]bool{
|
||||
"tools": m.Capabilities.Tools, "vision": m.Capabilities.Vision,
|
||||
"embeddings": m.Capabilities.Embeddings, "images": m.MakesImages(), "meshes": m.MakesMeshes(),
|
||||
"workflows": m.RunsWorkflows(),
|
||||
}
|
||||
// What a run of it takes and makes, so a client can build the form
|
||||
// without the catalog in hand.
|
||||
if m.RunsWorkflows() {
|
||||
var inputs any = m.ComfyInputs()
|
||||
if len(m.ComfyInputs()) == 0 {
|
||||
inputs = []any{}
|
||||
}
|
||||
entry["workflow"] = map[string]any{"output": m.ComfyOutput(), "inputs": inputs}
|
||||
}
|
||||
data = append(data, entry)
|
||||
}
|
||||
|
||||
@@ -112,6 +112,18 @@ func parseImageRequest(body []byte) (imageRequest, error) {
|
||||
// endpoint may serve as it likes.
|
||||
func (r *Router) imageRouteRefusal(path, model string, body []byte) string {
|
||||
m, known := r.modelMap()[model]
|
||||
if path == workflowsPath {
|
||||
if !known {
|
||||
return ""
|
||||
}
|
||||
if !m.RunsWorkflows() {
|
||||
return fmt.Sprintf("%s runs no ComfyUI workflow", m.Name)
|
||||
}
|
||||
if _, err := parseRunRequest(m, body); err != nil {
|
||||
return err.Error()
|
||||
}
|
||||
return ""
|
||||
}
|
||||
if path == meshesPath {
|
||||
if known && !m.MakesMeshes() {
|
||||
if m.MakesImages() {
|
||||
@@ -137,6 +149,9 @@ func (r *Router) imageRouteRefusal(path, model string, body []byte) string {
|
||||
return ""
|
||||
}
|
||||
if known && m.ServesComfyUI() {
|
||||
if !m.MakesMeshes() && !m.MakesImages() {
|
||||
return fmt.Sprintf("%s makes %s: ask for it at %s, as a job", m.Name, m.ComfyOutput(), workflowsPath)
|
||||
}
|
||||
if m.MakesMeshes() {
|
||||
return fmt.Sprintf("%s makes 3D models: ask for one at %s, as a job", m.Name, meshesPath)
|
||||
}
|
||||
@@ -149,11 +164,15 @@ func (r *Router) imageRouteRefusal(path, model string, body []byte) string {
|
||||
// proxy would: a failure of this replica that another may not have is
|
||||
// retryable, and nothing is written until the pictures are all in hand.
|
||||
func (r *Router) generateImages(ctx context.Context, w http.ResponseWriter, req *parsedRequest, ep endpoint.Info, body []byte) (proxy.Outcome, error) {
|
||||
if req.Path == meshesPath {
|
||||
switch req.Path {
|
||||
case meshesPath:
|
||||
return r.generateMeshes(ctx, w, req, ep, body)
|
||||
}
|
||||
if req.Path != imagesPath {
|
||||
return proxy.Outcome{}, fmt.Errorf("%s is a ComfyUI server: it answers %s and %s only", ep.ID, imagesPath, meshesPath)
|
||||
case workflowsPath:
|
||||
return r.generateRun(ctx, w, req, ep, body)
|
||||
case imagesPath:
|
||||
default:
|
||||
return proxy.Outcome{}, fmt.Errorf("%s is a ComfyUI server: it answers %s, %s and %s only", ep.ID,
|
||||
imagesPath, meshesPath, workflowsPath)
|
||||
}
|
||||
in, err := parseImageRequest(body)
|
||||
if err != nil {
|
||||
@@ -163,7 +182,8 @@ func (r *Router) generateImages(ctx context.Context, w http.ResponseWriter, req
|
||||
Model string `json:"model"`
|
||||
}
|
||||
_ = json.Unmarshal(body, &upstream)
|
||||
tpl, err := comfy.Load(ep.Workflow)
|
||||
wf, _ := ep.ComfyFor(req.Model)
|
||||
tpl, err := comfy.Load(wf)
|
||||
if err != nil {
|
||||
return proxy.Outcome{}, fmt.Errorf("%s: %w", ep.ID, err)
|
||||
}
|
||||
|
||||
+26
-8
@@ -11,7 +11,6 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/auth"
|
||||
"gitea.mynodes.xyz/ilker/llmgw/internal/store"
|
||||
)
|
||||
|
||||
@@ -66,11 +65,21 @@ func (r *Router) jobJSON(ctx context.Context, j store.Job) map[string]any {
|
||||
return out
|
||||
}
|
||||
|
||||
// handleCreateJob queues a request for a 3D model. Refused now: no key, a
|
||||
// model that is not there or not allowed, a request the model cannot serve.
|
||||
// Refused when it is served, and said as the job's error: limits, the
|
||||
// guardrails, a model that will not come up.
|
||||
// handleCreateJob queues a request for a 3D model.
|
||||
func (r *Router) handleCreateJob(w http.ResponseWriter, req *http.Request) {
|
||||
r.createJobAt(meshesPath)(w, req)
|
||||
}
|
||||
|
||||
// createJobAt queues a request at path: a 3D model, a workflow run. Refused
|
||||
// now: no key, a model that is not there or not allowed, a request the model
|
||||
// cannot serve, a file it names that is not the caller's. Refused when it is
|
||||
// served, and said as the job's error: limits, the guardrails, a model that
|
||||
// will not come up.
|
||||
func (r *Router) createJobAt(path string) http.HandlerFunc {
|
||||
return func(w http.ResponseWriter, req *http.Request) { r.createJob(w, req, path) }
|
||||
}
|
||||
|
||||
func (r *Router) createJob(w http.ResponseWriter, req *http.Request, path string) {
|
||||
p, ok := r.batchPrincipal(w, req)
|
||||
if !ok {
|
||||
return
|
||||
@@ -97,15 +106,24 @@ func (r *Router) handleCreateJob(w http.ResponseWriter, req *http.Request) {
|
||||
return
|
||||
}
|
||||
if !r.permits(p, in.Model) {
|
||||
auth.WriteForbiddenModel(w, in.Model)
|
||||
r.writeForbidden(w, p, in.Model)
|
||||
return
|
||||
}
|
||||
if why := r.imageRouteRefusal(meshesPath, in.Model, body); why != "" {
|
||||
if why := r.imageRouteRefusal(path, in.Model, body); why != "" {
|
||||
writeError(w, http.StatusBadRequest, "invalid_request_error", why)
|
||||
return
|
||||
}
|
||||
if path == workflowsPath {
|
||||
if m, known := r.modelMap()[in.Model]; known {
|
||||
run, _ := parseRunRequest(m, body)
|
||||
if err := r.checkRunFiles(req.Context(), ownerOf(p), run); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "invalid_request_error", err.Error())
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
now := time.Now()
|
||||
j := store.Job{ID: newID("job_"), Owner: ownerOf(p), KeyID: p.KeyID, Endpoint: meshesPath, Model: in.Model,
|
||||
j := store.Job{ID: newID("job_"), Owner: ownerOf(p), KeyID: p.KeyID, Endpoint: path, Model: in.Model,
|
||||
Input: body, Status: store.JobQueued, CreatedAt: now, ExpiresAt: now.Add(jobWindow)}
|
||||
if err := r.store.PutJob(req.Context(), j); err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "server_error", err.Error())
|
||||
|
||||
@@ -283,3 +283,109 @@ func TestJobsAreTheirOwners(t *testing.T) {
|
||||
t.Errorf("another project read a job's result: %d", code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAJobWaitingOnAnotherModelsCardsSaysSo(t *testing.T) {
|
||||
c := newJobComfy(t)
|
||||
rt, secret := jobRouter(t, c)
|
||||
rt.cfg.ActivationWait = 10 * time.Millisecond
|
||||
rt.SetActivator(&waitingActivator{fakeActivator: fakeActivator{onDemand: map[string]bool{"sleepy": true}},
|
||||
heldBy: "flux-schnell", eta: 90 * time.Second})
|
||||
j := queueJob(t, rt, "job_w", store.JobQueued, `{"model":"sleepy","prompt":"a cube"}`)
|
||||
rt.wakeJobs()
|
||||
|
||||
got := waitJob(t, rt.Handler(), secret, j.ID, func(j map[string]any) bool { return j["progress"] != nil })
|
||||
p, _ := got["progress"].(map[string]any)
|
||||
if got["status"] != "running" || p["state"] != "waiting_gpu" || p["held_by"] != "flux-schnell" || p["eta_seconds"] != 90.0 {
|
||||
t.Errorf("job %v", got)
|
||||
}
|
||||
}
|
||||
|
||||
type countingUnservable struct {
|
||||
unservableActivator
|
||||
asked atomic.Int32
|
||||
}
|
||||
|
||||
func (c *countingUnservable) Unservable(model string) (string, bool) {
|
||||
c.asked.Add(1)
|
||||
return c.unservableActivator.Unservable(model)
|
||||
}
|
||||
|
||||
func TestAJobSaidToFitNowhereKeepsAskingAWhileBeforeFailing(t *testing.T) {
|
||||
// An agent restarting re-registers without its engines for a few
|
||||
// seconds; five 3D jobs asked for in those seconds failed for good.
|
||||
grace, retry := jobUnplacedGrace, jobUnplacedRetry
|
||||
jobUnplacedGrace, jobUnplacedRetry = 300*time.Millisecond, 20*time.Millisecond
|
||||
t.Cleanup(func() { jobUnplacedGrace, jobUnplacedRetry = grace, retry })
|
||||
|
||||
c := newJobComfy(t)
|
||||
rt, secret := jobRouter(t, c)
|
||||
act := &countingUnservable{unservableActivator: unservableActivator{
|
||||
fakeActivator: fakeActivator{onDemand: map[string]bool{"sleepy": true}},
|
||||
why: map[string]string{"sleepy": "sleepy cannot be placed on any node: needs 15 GB"},
|
||||
}}
|
||||
rt.SetActivator(act)
|
||||
j := queueJob(t, rt, "job_u", store.JobQueued, `{"model":"sleepy","prompt":"a cube"}`)
|
||||
start := time.Now()
|
||||
rt.wakeJobs()
|
||||
|
||||
got := waitJob(t, rt.Handler(), secret, j.ID, jobDone)
|
||||
if got["status"] != "failed" || !strings.Contains(fmt.Sprint(got["error"]), "needs 15 GB") {
|
||||
t.Errorf("job %v", got)
|
||||
}
|
||||
if took := time.Since(start); took < jobUnplacedGrace {
|
||||
t.Errorf("failed after %s, before the grace of %s", took, jobUnplacedGrace)
|
||||
}
|
||||
if n := act.asked.Load(); n < 3 {
|
||||
t.Errorf("asked %d times in the grace", n)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAStandbyLeavesJobsToTheLeader(t *testing.T) {
|
||||
// A standby's router has no endpoints; a 3D job it leased was told
|
||||
// "loading" for seven minutes while the leader served the jobs behind it.
|
||||
c := newJobComfy(t)
|
||||
rt, secret := jobRouter(t, c)
|
||||
var lead atomic.Bool
|
||||
rt.SetLeader(lead.Load)
|
||||
j := queueJob(t, rt, "job_s", store.JobQueued, `{"model":"flux","prompt":"a cube"}`)
|
||||
rt.wakeJobs()
|
||||
time.Sleep(200 * time.Millisecond)
|
||||
if got, _ := rt.store.JobByID(t.Context(), j.ID); got.Status != store.JobQueued {
|
||||
t.Fatalf("a standby took the job: %s", got.Status)
|
||||
}
|
||||
|
||||
lead.Store(true)
|
||||
rt.wakeJobs()
|
||||
if got := waitJob(t, rt.Handler(), secret, j.ID, jobDone); got["status"] != "completed" {
|
||||
t.Errorf("the leader did not serve it: %v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAJobWaitingForTheCardDoesNotHoldUpAnotherModelsJob(t *testing.T) {
|
||||
// One at a time, an sf3d job waiting for the card held up a job for a
|
||||
// model that could have run.
|
||||
c := newJobComfy(t)
|
||||
rt, secret := jobRouter(t, c)
|
||||
rt.cfg.ActivationWait = 10 * time.Millisecond
|
||||
rt.SetActivator(&waitingActivator{fakeActivator: fakeActivator{onDemand: map[string]bool{"sleepy": true}},
|
||||
heldBy: "flux", eta: time.Hour})
|
||||
now := time.Now()
|
||||
put := func(id, model, body string, at time.Time) {
|
||||
if err := rt.store.PutJob(t.Context(), store.Job{ID: id, Owner: "project:" + mustProjectOf(t, rt, "key-1"),
|
||||
KeyID: "key-1", Endpoint: imagesPath, Model: model, Input: []byte(body), Status: store.JobQueued,
|
||||
CreatedAt: at, ExpiresAt: at.Add(jobWindow)}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
put("job_wait", "sleepy", `{"model":"sleepy","prompt":"a cube"}`, now.Add(-time.Minute))
|
||||
put("job_go", "flux", `{"model":"flux","prompt":"a cube"}`, now)
|
||||
rt.wakeJobs()
|
||||
|
||||
got := waitJob(t, rt.Handler(), secret, "job_go", jobDone)
|
||||
if got["status"] != "completed" {
|
||||
t.Errorf("the other model's job: %v", got)
|
||||
}
|
||||
if w, _ := rt.store.JobByID(t.Context(), "job_wait"); w.Status != store.JobRunning {
|
||||
t.Errorf("the waiting job is %s", w.Status)
|
||||
}
|
||||
}
|
||||
Loaded 100 of 167 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user