架構
frontend/ React 19 · TypeScript · React Flow 12 · Zustand 5 · Vite 6
backend/ Python 3.10+ · FastAPI · PyTorch
單一 uvicorn 行程同時提供 REST API、執行 WebSocket,以及預先建置好的 React 應用程式。
核心原則
| 原則 | 說明 |
|---|---|
| 後端權威 | GET /api/nodes 回傳每一個節點定義。新增一個後端節點即可讓它自動出現在 UI 中——無需修改前端。 |
| 單一 BaseNode 元件 | 一個 React 元件渲染所有節點類型,由後端定義參數化。 |
| WebSocket 執行 | ws://host/ws/execution 是伺服器所擁有之 run 的視圖:即時串流每個節點的狀態,也能從任意 cursor 重播該 run 已儲存的事件紀錄,讓重新連線的分頁完整接上。run 本身由 run service 擁有,而不是 socket。 |
| 拓撲排序執行 | 使用 Kahn 演算法進行 DAG 排序 + 循環偵測,並對獨立節點進行平行執行。 |
執行流程
- 送出——畫布、
cdui run、POST /api/runs或 sweep 會將圖送至 run service。該服務會將圖持久化並排程。queued 通道的 run 會進入各裝置的 FIFO;interactive 畫布 run 則會跳過佇列。詳見執行佇列。 - 預設組合展開——preset 節點會在任何東西執行之前被攤平成其內部節點。
- 驗證——檢查 DAG、連接埠/型別安全,以及是否有必要的
Start節點。節點只要能沿著 trigger 邊抵達,或透過 data 邊餵給一個能直接或間接如此抵達的節點,就會執行;data 邊接的是必要還是選用連接埠都沒有差別。像Dataset或轉換鏈開頭這類自身沒有 trigger 的根節點,只要其輸出會被執行中的節點使用,就會保留而不被剪掉(core#201)。 - 拓撲排序——使用 Kahn 演算法並進行循環偵測。
- 平行執行——獨立節點並行執行,一次最多
CODEFYUI_MAX_PARALLEL_NODES個。 - 快取/髒節點追蹤——具決定性的節點輸出會依 WebSocket 連線個別快取(預設 256 筆與 1 GB),快取鍵包含節點類型、params、每條輸入邊的一份參照(上游鍵加上兩端的連接埠名稱)、解析後的裝置,以及讀檔節點的內容指紋;變更一個節點會把它與其下游標記為 dirty,因此只有受影響的子圖會重新執行。非決定性節點(或
cacheable = False)一律執行。 - 裝置解析——被請求的裝置會與可用的裝置比對,若不存在則退回 CPU 並發出警告。請參閱裝置後端。
狀態、輸出與梯度
- Run service——
RunService會獨立於 WebSocket 連線管理每個 run。它會將每個引擎事件附加至持久事件紀錄、批次寫入純量指標,並透過執行環境協作式取消。啟動時,它會將上一個行程留下的queued或running資料列標記為interrupted。run、事件、指標與產出會儲存在 SQLite(exec_runs、exec_run_events、exec_run_metrics、exec_run_artifacts),讓分頁可以重新連線,終端機也可以監控由其他用戶端啟動的 run。 - 執行環境攜帶每次執行的選項:裝置、「顯示內部步驟」模式、權重持久化與梯度目標。
- 有狀態模組——一個 mixin 透過以(graph id、node id、structure hash)為鍵的鍵值儲存區,在多次執行之間保留
nn.Module權重,因此開啟在多次執行間保留權重時,模型能在多次執行點擊之間持續學習。 - Run 輸出儲存區——全伺服器共用的記憶體儲存區,會保留教學檢視器使用的擷取輸出,並透過 REST 依需求提供。預設最多追蹤 20 次 run 與 2 GiB;超過任一限制時,會逐出完整且最舊的 run。
- 反向傳播——開啟擷取梯度時,引擎會掛上 hook、呼叫
.backward(),並把每層的梯度與輸出一起儲存。 - 步驟追蹤——在「顯示內部步驟」模式下,受插樁的節點會發出
__steps__追蹤,記錄供檢視器的步驟分頁使用。
節點註冊表與可擴充性
- 註冊表透過走訪節點套件來探索
BaseNode子類別。內建節點使用裸名稱(Conv2d);外掛節點則加上命名空間(foundations:Edu-KNN),以避免衝突並讓圖能自我說明。 - 自訂節點——把一個
.py檔案放進custom_nodes/,即可熱重載。 - 外掛包——透過 CLI 安裝、藉由 lockfile 探索,並在載入第三方程式碼之前經過 AST 驗證。
- 預設組合——可重用的子圖,於執行時展開。
進入點
| 區域 | 檔案 |
|---|---|
| FastAPI 應用程式、lifespan、路由 | backend/app/main.py |
| BaseNode ABC | backend/app/core/node_base.py |
| 節點註冊表 + 命名空間 | backend/app/core/node_registry.py |
| 圖驗證 + 執行 | backend/app/core/graph_engine.py |
| Run service(排程、事件紀錄、取消、復原) | backend/app/core/run_service.py |
| Run 儲存區(SQLite 資料列、保留政策) | backend/app/core/run_store.py |
| Run REST 路由 | backend/app/api/routes_runs.py |
| 參數掃描 | backend/app/api/routes_sweeps.py, backend/app/core/sweep_compiler.py |
| WebSocket 處理器 | backend/app/api/ws_execution.py |
| 外掛探索 | backend/app/core/plugin_loader.py |
| 外掛 AST 閘門 | backend/app/core/plugins/gate.py, backend/app/core/plugin_validator.py |
| CLI 圖形執行器 | backend/run_graph.py |
| 前端根元件 | frontend/src/App.tsx |
| WebSocket 客戶端 | frontend/src/api/ws.ts |
:::tip 貢獻 後端權威的設計意味著,大多數「新增一項功能」只需要新增一個 Python 節點。請先參閱自訂節點,接著再進階到外掛包來分享它。 :::