mirror of
https://github.com/LostRuins/koboldcpp.git
synced 2026-05-18 06:19: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>
156 lines
9 KiB
Markdown
156 lines
9 KiB
Markdown
```mermaid
|
|
sequenceDiagram
|
|
participant UI as 🧩 ChatSettings
|
|
participant settingsStore as 🗄️ settingsStore
|
|
participant serverStore as 🗄️ serverStore
|
|
participant ParamSvc as ⚙️ ParameterSyncService
|
|
participant LS as 💾 LocalStorage
|
|
|
|
Note over settingsStore: State:<br/>config: SettingsConfigType<br/>theme: string ("auto" | "light" | "dark")<br/>isInitialized: boolean<br/>userOverrides: Set<string>
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 🚀 INITIALIZATION
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
Note over settingsStore: Auto-initialized in constructor (browser only)
|
|
settingsStore->>settingsStore: initialize()
|
|
activate settingsStore
|
|
|
|
settingsStore->>settingsStore: loadConfig()
|
|
settingsStore->>LS: get("llama-config")
|
|
LS-->>settingsStore: StoredConfig | null
|
|
|
|
alt config exists
|
|
settingsStore->>settingsStore: Merge with SETTING_CONFIG_DEFAULT
|
|
Note right of settingsStore: Fill missing keys with defaults
|
|
else no config
|
|
settingsStore->>settingsStore: config = SETTING_CONFIG_DEFAULT
|
|
end
|
|
|
|
settingsStore->>LS: get("llama-userOverrides")
|
|
LS-->>settingsStore: string[] | null
|
|
settingsStore->>settingsStore: userOverrides = new Set(data)
|
|
|
|
settingsStore->>settingsStore: loadTheme()
|
|
settingsStore->>LS: get("llama-theme")
|
|
LS-->>settingsStore: theme | "auto"
|
|
|
|
settingsStore->>settingsStore: isInitialized = true
|
|
deactivate settingsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 🔄 SYNC WITH SERVER DEFAULTS
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
Note over UI: Triggered from +layout.svelte when serverStore.props loaded
|
|
UI->>settingsStore: syncWithServerDefaults()
|
|
activate settingsStore
|
|
|
|
settingsStore->>serverStore: defaultParams
|
|
serverStore-->>settingsStore: {temperature, top_p, top_k, ...}
|
|
|
|
loop each SYNCABLE_PARAMETER
|
|
alt key NOT in userOverrides
|
|
settingsStore->>settingsStore: config[key] = serverDefault[key]
|
|
Note right of settingsStore: Non-overridden params adopt server default
|
|
else key in userOverrides
|
|
Note right of settingsStore: Keep user value, skip server default
|
|
end
|
|
end
|
|
|
|
alt serverStore.props has uiSettings
|
|
settingsStore->>settingsStore: Apply uiSettings from server
|
|
Note right of settingsStore: Server-provided UI settings<br/>(e.g. showRawOutputSwitch)
|
|
end
|
|
|
|
settingsStore->>settingsStore: saveConfig()
|
|
deactivate settingsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: ⚙️ UPDATE CONFIG
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>settingsStore: updateConfig(key, value)
|
|
activate settingsStore
|
|
settingsStore->>settingsStore: config[key] = value
|
|
|
|
alt value matches server default for key
|
|
settingsStore->>settingsStore: userOverrides.delete(key)
|
|
Note right of settingsStore: Matches server default, remove override
|
|
else value differs from server default
|
|
settingsStore->>settingsStore: userOverrides.add(key)
|
|
Note right of settingsStore: Mark as user-modified (won't be overwritten)
|
|
end
|
|
|
|
settingsStore->>settingsStore: saveConfig()
|
|
settingsStore->>LS: set(CONFIG_LOCALSTORAGE_KEY, config)
|
|
settingsStore->>LS: set(USER_OVERRIDES_LOCALSTORAGE_KEY, [...userOverrides])
|
|
deactivate settingsStore
|
|
|
|
UI->>settingsStore: updateMultipleConfig({key1: val1, key2: val2})
|
|
activate settingsStore
|
|
Note right of settingsStore: Batch update, single save
|
|
settingsStore->>settingsStore: For each key: config[key] = value
|
|
settingsStore->>settingsStore: For each key: userOverrides.add(key)
|
|
settingsStore->>settingsStore: saveConfig()
|
|
deactivate settingsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 🔄 RESET
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>settingsStore: resetConfig()
|
|
activate settingsStore
|
|
settingsStore->>settingsStore: config = {...SETTING_CONFIG_DEFAULT}
|
|
settingsStore->>settingsStore: userOverrides.clear()
|
|
Note right of settingsStore: All params reset to defaults<br/>Next syncWithServerDefaults will adopt server values
|
|
settingsStore->>settingsStore: saveConfig()
|
|
deactivate settingsStore
|
|
|
|
UI->>settingsStore: resetParameterToServerDefault(key)
|
|
activate settingsStore
|
|
settingsStore->>settingsStore: userOverrides.delete(key)
|
|
settingsStore->>serverStore: defaultParams[key]
|
|
settingsStore->>settingsStore: config[key] = serverDefault
|
|
settingsStore->>settingsStore: saveConfig()
|
|
deactivate settingsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 🎨 THEME
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>settingsStore: updateTheme(newTheme)
|
|
activate settingsStore
|
|
settingsStore->>settingsStore: theme = newTheme
|
|
settingsStore->>settingsStore: saveTheme()
|
|
settingsStore->>LS: set("llama-theme", theme)
|
|
deactivate settingsStore
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 📊 PARAMETER INFO
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
UI->>settingsStore: getParameterInfo(key)
|
|
settingsStore->>ParamSvc: getParameterInfo(key, config, serverDefaults, userOverrides)
|
|
ParamSvc-->>settingsStore: ParameterInfo
|
|
Note right of ParamSvc: {<br/> currentValue,<br/> serverDefault,<br/> isUserOverride: boolean,<br/> canSync: boolean,<br/> isDifferentFromServer: boolean<br/>}
|
|
|
|
UI->>settingsStore: getParameterDiff()
|
|
settingsStore->>ParamSvc: createParameterDiff(config, serverDefaults, userOverrides)
|
|
ParamSvc-->>settingsStore: ParameterDiff[]
|
|
Note right of ParamSvc: Array of parameters where user != server
|
|
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
Note over UI,LS: 📋 CONFIG CATEGORIES
|
|
%% ═══════════════════════════════════════════════════════════════════════════
|
|
|
|
Note over settingsStore: Syncable with server (from /props):
|
|
rect rgb(240, 255, 240)
|
|
Note over settingsStore: temperature, top_p, top_k, min_p<br/>repeat_penalty, presence_penalty, frequency_penalty<br/>dynatemp_range, dynatemp_exponent<br/>typ_p, xtc_probability, xtc_threshold<br/>dry_multiplier, dry_base, dry_allowed_length, dry_penalty_last_n
|
|
end
|
|
|
|
Note over settingsStore: UI-only (not synced):
|
|
rect rgb(255, 240, 240)
|
|
Note over settingsStore: systemMessage, custom (JSON)<br/>showStatistics, enableContinueGeneration<br/>autoMicOnEmpty, disableAutoScroll<br/>apiKey, pdfAsImage, disableReasoningParsing, showRawOutputSwitch
|
|
end
|
|
```
|