summaryrefslogtreecommitdiff
path: root/llama.cpp/tools/server/webui/docs/flows/settings-flow.md
diff options
context:
space:
mode:
Diffstat (limited to 'llama.cpp/tools/server/webui/docs/flows/settings-flow.md')
-rw-r--r--llama.cpp/tools/server/webui/docs/flows/settings-flow.md144
1 files changed, 144 insertions, 0 deletions
diff --git a/llama.cpp/tools/server/webui/docs/flows/settings-flow.md b/llama.cpp/tools/server/webui/docs/flows/settings-flow.md
new file mode 100644
index 0000000..578e01e
--- /dev/null
+++ b/llama.cpp/tools/server/webui/docs/flows/settings-flow.md
@@ -0,0 +1,144 @@
+```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&lt;string&gt;
+
+ %% ═══════════════════════════════════════════════════════════════════════════
+ 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, ...}
+
+ settingsStore->>ParamSvc: extractServerDefaults(defaultParams)
+ ParamSvc-->>settingsStore: Record<string, value>
+
+ settingsStore->>ParamSvc: mergeWithServerDefaults(config, serverDefaults)
+ Note right of ParamSvc: For each syncable parameter:<br/>- If NOT in userOverrides → use server default<br/>- If in userOverrides → keep user value
+ ParamSvc-->>settingsStore: mergedConfig
+
+ settingsStore->>settingsStore: config = mergedConfig
+ settingsStore->>settingsStore: saveConfig()
+ deactivate settingsStore
+
+ %% ═══════════════════════════════════════════════════════════════════════════
+ Note over UI,LS: ⚙️ UPDATE CONFIG
+ %% ═══════════════════════════════════════════════════════════════════════════
+
+ UI->>settingsStore: updateConfig(key, value)
+ activate settingsStore
+ settingsStore->>settingsStore: config[key] = value
+ settingsStore->>settingsStore: userOverrides.add(key)
+ Note right of settingsStore: Mark as user-modified (won't be overwritten by server)
+ settingsStore->>settingsStore: saveConfig()
+ settingsStore->>LS: set("llama-config", config)
+ settingsStore->>LS: set("llama-userOverrides", [...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()
+ settingsStore->>settingsStore: syncWithServerDefaults()
+ Note right of settingsStore: Apply server defaults for syncable params
+ 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, disableReasoningFormat
+ end
+```