docs: add dedicated "Obtain models" guide for the pick-free install#1086
Merged
Conversation
A single reference page for getting models onto a fresh (pick-free) hal0: the registry as source of truth, the model store (incl. `hal0 model store` show/change/migrate and the separate `[models].flm_store`), all the ways to add a model (pull from HF, `hal0 model add` a local file, `hal0 model scan` a directory, upstream providers), the list→pull→assign→start flow plus the `hal0 model run` one-shot, NPU/FastFlowLM, and ComfyUI capability models — dashboard and CLI side by side. Troubleshooting leads with `hal0 doctor models`. Aligned with the model-store CLI landed in #1088. Addresses the model-obtainment gap tracked in #1083 / #1084. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
e9f8f05 to
e1af895
Compare
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a single dedicated documentation page,
docs/guides/obtain-models.mdx(slug/docs/guides/obtain-models/, sidebar order15), covering how an operator obtains models on hal0.This addresses the model-obtainment documentation gap tracked in #1083 / #1084 (referenced, not closed). Since PR #1085 (
60444fa/fc50839) the installer no longer ships model picks — a fresh box boots with services up but zero models and zero slots (hal0 setup --auto --no-slotsseeds sentinel + wiring only). The page is written for that pick-free reality and never claims the installer selects or pulls a model.Coverage
Documented with Dashboard and CLI side by side (Starlight
Tabs):/var/lib/hal0/models;hal0 setup --storage-dir;[models].store(single source of truth) superseding the deprecated[models].pull_root;HAL0_MODEL_STORE; the/mnt/ai-modelsmount default.list → pull → assign → start-slotflow.family:sizetags, hostflmcache,npuslot wiring.Cross-links to/from
getting-started/first-model,guides/choose-models,guides/pull-and-register-models,guides/manage-slots,guides/generate-images,reference/cli,reference/paths-and-files. Leans onpull-and-register-modelsfor the deep pull-lifecycle mechanics rather than duplicating them.Real commands / endpoints documented (verified against source)
src/hal0/cli/model_commands.py):hal0 model list [--json],pull <alias|id>,register <id> --path --name --license,rm,show,assign --slot. Slot start:hal0 slot load <name>.POST /api/models/<id>/pull(+hf_repo/hf_filename/labelsfor by-coords);/pull/status. HF proxy:GET /api/hf/search,POST /api/models/inspect.hal0 model scanCLI — API only, flagged explicitly):POST /api/models/scan/previewthenPOST /api/models/add-from-pathper file; legacy full-rootPOST /api/models/scan(empty body), auto-run at startup when[models].auto_scan_on_start.hal0 model register→POST /api/models; capability-detectingPOST /api/models/add-from-path.hal0 model pull <family:size>auto-routes through hostflm pull(is_flm_tag); FLM weights live in~/.config/flm/models, not the registry.POST /api/comfyui/models/fetch({"auto":true}or{"selections":[...]}) with theCAPABILITIESregistry (txt2img/img2img/txt2video/img2video/image_upscale).Omitted / flagged
hal0 model scansubcommand exists — stated plainly; scanning documented via the real API + dashboard modal.hal0 slot createhas no--device npuflag (--hardwareisvulkan/rocm/cpuonly) — NPU slot provisioning is routed throughhal0 setup.Verified
astro buildin the docs workspace (hal0-web) builds the page cleanly —/docs/guides/obtain-models/index.htmlgenerated, no MDX errors, no broken-link warnings.🤖 Generated with Claude Code