mirror of
https://github.com/LostRuins/koboldcpp.git
synced 2026-05-17 04:09:19 +00:00
* webui: Move static build output from `tools/server/public` to `build/ui` directory * refactor: Move to `tools/ui` * refactor: rename CMake variables and preprocessor defines - Rename LLAMA_BUILD_WEBUI -> LLAMA_BUILD_UI (old kept as deprecated) - Rename LLAMA_USE_PREBUILT_WEBUI -> LLAMA_USE_PREBUILT_UI (old kept as deprecated) - Backward compat: old vars auto-forward to new ones with DEPRECATION warning - Rename internal vars: WEBUI_SOURCE -> UI_SOURCE, WEBUI_SOURCE_DIR -> UI_SOURCE_DIR, etc. - Rename HF bucket: LLAMA_WEBUI_HF_BUCKET -> LLAMA_UI_HF_BUCKET - Emit both LLAMA_BUILD_WEBUI and LLAMA_BUILD_UI preprocessor defines - Emit both LLAMA_WEBUI_DEFAULT_ENABLED and LLAMA_UI_DEFAULT_ENABLED * refactor: rename CLI flags (--webui -> --ui) with backward compat - Add --ui/--no-ui (old --webui/--no-webui kept as deprecated aliases) - Add --ui-config (old --webui-config kept as deprecated alias) - Add --ui-config-file (old --webui-config-file kept as deprecated alias) - Add --ui-mcp-proxy/--no-ui-mcp-proxy (old --webui-mcp-proxy kept as deprecated) - Add new env vars: LLAMA_ARG_UI, LLAMA_ARG_UI_CONFIG, LLAMA_ARG_UI_CONFIG_FILE, LLAMA_ARG_UI_MCP_PROXY - C++ struct fields: params.ui, params.ui_config_json, params.ui_mcp_proxy added alongside old fields - Backward compat: old fields synced to new ones in g_params_to_internals * refactor: update C++ server internals with backward compat - Rename json_webui_settings -> json_ui_settings (both kept in server_context_meta) - Rename params.webui usage -> params.ui (both synced, old still works) - JSON API emits both "ui"/"ui_settings" and "webui"/"webui_settings" keys - Server routes use params.ui_mcp_proxy || params.webui_mcp_proxy - Preprocessor guards use #if defined(LLAMA_BUILD_UI) || defined(LLAMA_BUILD_WEBUI) * refactor: rename CI/CD workflows, artifacts, and build script - Rename webui-build.yml -> ui-build.yml; artifact webui-build -> ui-build - Rename webui-publish.yml -> ui-publish.yml; var HF_BUCKET_WEBUI_STATIC_OUTPUT -> HF_BUCKET_UI_STATIC_OUTPUT - Rename server-webui.yml -> server-ui.yml; job webui-build/checks -> ui-build/checks - Update server.yml: job/artifact refs webui-build -> ui-build - Update release.yml: all webui-build/publish refs -> ui-build/publish; HF_TOKEN_WEBUI_STATIC_OUTPUT -> HF_TOKEN_UI_STATIC_OUTPUT - Update server-self-hosted.yml: webui-build -> ui-build - Update build-self-hosted.yml: HF_WEBUI_VERSION -> HF_UI_VERSION - Rename webui-download.cmake -> ui-download.cmake (internal refs updated) - Update labeler.yml: server/webui -> server/ui path label * docs: update CODEOWNERS and server README docs - Update CODEOWNERS: team ggml-org/llama-webui -> ggml-org/llama-ui, path /tools/server/webui/ -> /tools/ui/ - Update server README.md: CLI tables show --ui flags with deprecated --webui aliases - Update server README-dev.md: "WebUI" -> "UI", paths updated to tools/ui/ * fix: Small fixes for UI build * fix: CMake.txt syntax * chore: Formatting * fix: `.editorconfig` for llama-ui * chore: Formatting * refactor: Use `APP_NAME` in Error route * refactor: Cleanup * refactor: Single migration service * make llama-ui a linkable target * fix: UI Build output * fix: Missing change * fix: separate llama-ui npm build output into build/tools/ui/dist subfolder + use cmake npm build instead of downloading ui-build.yml artifacts in CI * refactor: UI workflows cleanup --------- Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
181 lines
9.3 KiB
Markdown
181 lines
9.3 KiB
Markdown
```mermaid
|
|
sequenceDiagram
|
|
participant UI as 🧩 ModelsSelector
|
|
participant Hooks as 🪝 useModelChangeValidation
|
|
participant modelsStore as 🗄️ modelsStore
|
|
participant serverStore as 🗄️ serverStore
|
|
participant convStore as 🗄️ conversationsStore
|
|
participant ModelsSvc as ⚙️ ModelsService
|
|
participant PropsSvc as ⚙️ PropsService
|
|
participant API as 🌐 llama-server
|
|
|
|
Note over modelsStore: State:<br/>models: ModelOption[]<br/>routerModels: ApiModelDataEntry[]<br/>selectedModelId, selectedModelName<br/>loading, updating, error<br/>modelLoadingStates (Map)<br/>modelPropsCache (Map)<br/>propsCacheVersion
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: 🚀 INITIALIZATION (MODEL mode)
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>modelsStore: fetch()
|
|
activate modelsStore
|
|
modelsStore->>modelsStore: loading = true
|
|
|
|
alt serverStore.props not loaded
|
|
modelsStore->>serverStore: fetch()
|
|
Note over serverStore: → see server-flow.mmd
|
|
end
|
|
|
|
modelsStore->>ModelsSvc: list()
|
|
ModelsSvc->>API: GET /v1/models
|
|
API-->>ModelsSvc: ApiModelListResponse {data: [model]}
|
|
|
|
modelsStore->>modelsStore: models = $state(mapped)
|
|
Note right of modelsStore: Map to ModelOption[]:<br/>{id, name, model, description, capabilities}
|
|
|
|
Note over modelsStore: MODEL mode: Get modalities from serverStore.props
|
|
modelsStore->>modelsStore: modelPropsCache.set(model.id, serverStore.props)
|
|
modelsStore->>modelsStore: models[0].modalities = props.modalities
|
|
|
|
modelsStore->>modelsStore: Auto-select single model
|
|
Note right of modelsStore: selectedModelId = models[0].id
|
|
modelsStore->>modelsStore: loading = false
|
|
deactivate modelsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: 🚀 INITIALIZATION (ROUTER mode)
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>modelsStore: fetch()
|
|
activate modelsStore
|
|
modelsStore->>ModelsSvc: list()
|
|
ModelsSvc->>API: GET /v1/models
|
|
API-->>ModelsSvc: ApiModelListResponse
|
|
modelsStore->>modelsStore: models = $state(mapped)
|
|
deactivate modelsStore
|
|
|
|
Note over UI: After models loaded, layout triggers:
|
|
UI->>modelsStore: fetchRouterModels()
|
|
activate modelsStore
|
|
modelsStore->>ModelsSvc: listRouter()
|
|
ModelsSvc->>API: GET /v1/models
|
|
API-->>ModelsSvc: ApiRouterModelsListResponse
|
|
Note right of API: {data: [{id, status, path, in_cache}]}
|
|
modelsStore->>modelsStore: routerModels = $state(data)
|
|
|
|
modelsStore->>modelsStore: fetchModalitiesForLoadedModels()
|
|
loop each model where status === "loaded"
|
|
modelsStore->>PropsSvc: fetchForModel(modelId)
|
|
PropsSvc->>API: GET /props?model={modelId}
|
|
API-->>PropsSvc: ApiLlamaCppServerProps
|
|
modelsStore->>modelsStore: modelPropsCache.set(modelId, props)
|
|
end
|
|
modelsStore->>modelsStore: propsCacheVersion++
|
|
deactivate modelsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: 🔄 MODEL SELECTION (ROUTER mode)
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>Hooks: useModelChangeValidation({getRequiredModalities, onSuccess?, onValidationFailure?})
|
|
Note over Hooks: Hook configured per-component:<br/>ChatForm: getRequiredModalities = usedModalities<br/>ChatMessage: getRequiredModalities = getModalitiesUpToMessage(msgId)
|
|
|
|
UI->>Hooks: handleModelChange(modelId, modelName)
|
|
activate Hooks
|
|
Hooks->>Hooks: previousSelectedModelId = modelsStore.selectedModelId
|
|
Hooks->>modelsStore: isModelLoaded(modelName)?
|
|
|
|
alt model NOT loaded
|
|
Hooks->>modelsStore: loadModel(modelName)
|
|
Note over modelsStore: → see LOAD MODEL section below
|
|
end
|
|
|
|
Note over Hooks: Always fetch props (from cache or API)
|
|
Hooks->>modelsStore: fetchModelProps(modelName)
|
|
modelsStore-->>Hooks: props
|
|
|
|
Hooks->>convStore: getRequiredModalities()
|
|
convStore-->>Hooks: {vision, audio}
|
|
|
|
Hooks->>Hooks: Validate: model.modalities ⊇ required?
|
|
|
|
alt validation PASSED
|
|
Hooks->>modelsStore: selectModelById(modelId)
|
|
Hooks-->>UI: return true
|
|
else validation FAILED
|
|
Hooks->>UI: toast.error("Model doesn't support required modalities")
|
|
alt model was just loaded
|
|
Hooks->>modelsStore: unloadModel(modelName)
|
|
end
|
|
alt onValidationFailure provided
|
|
Hooks->>modelsStore: selectModelById(previousSelectedModelId)
|
|
end
|
|
Hooks-->>UI: return false
|
|
end
|
|
deactivate Hooks
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: ⬆️ LOAD MODEL (ROUTER mode)
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
modelsStore->>modelsStore: loadModel(modelId)
|
|
activate modelsStore
|
|
|
|
alt already loaded
|
|
modelsStore-->>modelsStore: return (no-op)
|
|
end
|
|
|
|
modelsStore->>modelsStore: modelLoadingStates.set(modelId, true)
|
|
modelsStore->>ModelsSvc: load(modelId)
|
|
ModelsSvc->>API: POST /models/load {model: modelId}
|
|
API-->>ModelsSvc: {status: "loading"}
|
|
|
|
modelsStore->>modelsStore: pollForModelStatus(modelId, LOADED)
|
|
loop poll every 500ms (max 60 attempts)
|
|
modelsStore->>modelsStore: fetchRouterModels()
|
|
modelsStore->>ModelsSvc: listRouter()
|
|
ModelsSvc->>API: GET /v1/models
|
|
API-->>ModelsSvc: models[]
|
|
modelsStore->>modelsStore: getModelStatus(modelId)
|
|
alt status === LOADED
|
|
Note right of modelsStore: break loop
|
|
else status === LOADING
|
|
Note right of modelsStore: wait 500ms, continue
|
|
end
|
|
end
|
|
|
|
modelsStore->>modelsStore: updateModelModalities(modelId)
|
|
modelsStore->>PropsSvc: fetchForModel(modelId)
|
|
PropsSvc->>API: GET /props?model={modelId}
|
|
API-->>PropsSvc: props with modalities
|
|
modelsStore->>modelsStore: modelPropsCache.set(modelId, props)
|
|
modelsStore->>modelsStore: propsCacheVersion++
|
|
|
|
modelsStore->>modelsStore: modelLoadingStates.set(modelId, false)
|
|
deactivate modelsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: ⬇️ UNLOAD MODEL (ROUTER mode)
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
modelsStore->>modelsStore: unloadModel(modelId)
|
|
activate modelsStore
|
|
modelsStore->>modelsStore: modelLoadingStates.set(modelId, true)
|
|
modelsStore->>ModelsSvc: unload(modelId)
|
|
ModelsSvc->>API: POST /models/unload {model: modelId}
|
|
|
|
modelsStore->>modelsStore: pollForModelStatus(modelId, UNLOADED)
|
|
loop poll until unloaded
|
|
modelsStore->>ModelsSvc: listRouter()
|
|
ModelsSvc->>API: GET /v1/models
|
|
end
|
|
|
|
modelsStore->>modelsStore: modelLoadingStates.set(modelId, false)
|
|
deactivate modelsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,API: 📊 COMPUTED GETTERS
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
Note over modelsStore: Getters:<br/>- selectedModel: ModelOption | null<br/>- loadedModelIds: string[] (from routerModels)<br/>- loadingModelIds: string[] (from modelLoadingStates)<br/>- singleModelName: string | null (MODEL mode only)
|
|
|
|
Note over modelsStore: Modality helpers:<br/>- getModelModalities(modelId): {vision, audio}<br/>- modelSupportsVision(modelId): boolean<br/>- modelSupportsAudio(modelId): boolean
|
|
```
|