Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"installation/desktop/usage/downloads",
"installation/desktop/usage/manage",
"installation/desktop/usage/settings",
"installation/desktop/usage/performance-tests",
"installation/desktop/usage/migrate"
]
},
Expand Down Expand Up @@ -3893,6 +3894,7 @@
"zh/installation/desktop/usage/downloads",
"zh/installation/desktop/usage/manage",
"zh/installation/desktop/usage/settings",
"zh/installation/desktop/usage/performance-tests",
"zh/installation/desktop/usage/migrate"
]
},
Expand Down Expand Up @@ -7752,6 +7754,7 @@
"ja/installation/desktop/usage/downloads",
"ja/installation/desktop/usage/manage",
"ja/installation/desktop/usage/settings",
"ja/installation/desktop/usage/performance-tests",
"ja/installation/desktop/usage/migrate"
]
},
Expand Down Expand Up @@ -11624,6 +11627,7 @@
"ko/installation/desktop/usage/downloads",
"ko/installation/desktop/usage/manage",
"ko/installation/desktop/usage/settings",
"ko/installation/desktop/usage/performance-tests",
"ko/installation/desktop/usage/migrate"
]
},
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 19 additions & 2 deletions installation/desktop/usage/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,29 @@ Comfy Desktop window is divided into several key areas. The image below labels t

### App Menu

The hamburger menu (☰) in the top-left corner opens the application menu (File / Edit / View / Window / Help). Use it to open a new window, access **Desktop Settings**, **Log in** to your Comfy account, quit the app, or find other desktop-level controls.
The hamburger menu (☰) in the top-left corner opens the application menu, which holds every app-level action:

<CardGroup cols={1}>
- **Open Dashboard**: opens the Dashboard in a new window. Instances that are running keep running.
- **New Instance** and **Add Existing Instance**: create a new instance, or track a ComfyUI installation you already have.
- **Load Snapshot**: create an instance from a snapshot file someone shared with you.
- **Log in**: sign in to your Comfy account. This entry only appears while you are signed out.
- **Performance Tests**: run timed workflows against an instance. See [Performance Tests and Benchmarks](/installation/desktop/usage/performance-tests).
- **Benchmarks**: compare saved performance test results across hardware, workflows, and instances.
- **Desktop Settings**: global settings for auto-updates, proxy/mirror, shared storage, and data locations.
- **Send Feedback**: open the feedback panel.
- **Close Window** and **Quit Desktop**: close the current window, or quit the app. Closing an instance window stops the ComfyUI instance it runs, and closing the last window quits Comfy Desktop.

Two entries appear only in context: **Reset Zoom (N%)** once the ComfyUI view is zoomed, and **Skip Onboarding** during the first-run setup. While the first-run setup is on screen, **Skip Onboarding** is the only entry in the menu.

On macOS the app also keeps a system menu bar with the standard app, Edit, and Window menus. Windows and Linux builds have no system menu bar.

<CardGroup cols={2}>
<Card title="Settings" icon="cog" href="/installation/desktop/usage/settings">
Global settings: auto-updates, proxy/mirror, shared storage, and data locations.
</Card>
<Card title="Performance Tests" icon="gauge" href="/installation/desktop/usage/performance-tests">
Measure workflow speed on an instance, then compare runs across hardware.
</Card>
</CardGroup>

### Instance Switcher
Expand Down
146 changes: 146 additions & 0 deletions installation/desktop/usage/performance-tests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
---
title: "Performance Tests and Benchmarks"
description: "Measure ComfyUI workflow speed with Performance Tests, then compare runs across GPUs, workflows, and instances with Benchmarks in Comfy Desktop"
icon: "gauge"
sidebarTitle: "Performance Tests"
---

**Performance Tests** measures how long a ComfyUI workflow takes to run on one of your instances. You pick an instance, load a workflow, and Comfy Desktop runs it a set number of times, timing every measured run and reporting the fastest, slowest, average, and median duration together with the hardware and software the numbers came from.

**Benchmarks** compares those recorded results. It lists every saved run, filters them by workspace, instance, hardware, or workflow, and lines up selected runs side by side with a relative speed factor, so you can see how much faster one GPU, workflow, or instance is than another.

Both panels open from the app menu: click the ☰ menu in the top-left corner and select **Performance Tests** or **Benchmarks**.

<Info>
Performance Tests runs a real workflow on a real instance, so a test takes roughly as long as the workflow itself multiplied by the number of runs. Workflows you import have to be exported in [API format](/development/api-development/workflow-api-format) first. The example workflows that ship with Comfy Desktop are already in that format.
</Info>

## Running a Performance Test

The panel is laid out as three numbered steps side by side. They stack vertically on narrow windows.

![The Performance Tests panel with an instance selected and the three numbered steps](/images/desktop/usage/performance_tests_01_panel.png)

### 1. Select an instance

Choose the **Workspace** and the **Instance** to test. The instance and its hardware are recorded with the results, which is what makes later comparisons meaningful: runs from different GPUs stay distinguishable.

When you start a test, Comfy Desktop stops that instance's previous performance test session if one is still running, then launches the instance in a console session. Comfy Desktop refuses to start a test while any other local ComfyUI is running, still starting, or stopping, and names the instances in the way. Stop them, or wait for them to finish starting or stopping, then run the test again. Comfy Cloud and remote instances run elsewhere and never block a test. Other work that keeps the GPU busy, such as a game or a video export, still affects the numbers, so stop it before you run a test.

### 2. Choose a workflow

You can pick an example workflow that ships with Comfy Desktop, or bring your own.

**Example workflows** are ready to run, and their models are downloaded for you. Click **Choose an example workflow** to open the picker. It groups the examples into modality tabs (Video, Image, 3D, and Audio; only modalities that have examples get a tab), and each card shows the example's name, task, and how much its models download. Click **Use workflow** to select one. Comfy Desktop then downloads any models the workflow is still missing, and the drop zone shows the download progress until it finishes. To pick an example, the instance has to be fully installed and you have to be online; if the models would not fit in the free disk space, the picker blocks the selection. Example workflows are tied to an instance: switching to another instance drops the example prepared for the first one, unless that example's session already recorded results.

**Your own workflow** has to be exported in [API format](/development/api-development/workflow-api-format). Drop the `.json` file onto the drop zone, or click the zone to browse for one.

![The example workflow picker with modality tabs and workflow cards showing the model download size](/images/desktop/usage/performance_tests_02_example_workflows.png)

Either way, Comfy Desktop copies the workflow into the test session folder, so the test still runs after you move or edit the original file.

### 3. Set measurement settings

| Setting | Range | Default | What it does |
|---------|-------|---------|--------------|
| **Warm-up runs** | 1 to 5 | 1 | Runs executed first to load models and warm up caches. They are not included in the results. |
| **Measured runs** | 1 to 100 | 5 | Runs timed after the warm-up runs. Their durations are used to calculate the results. |

Every run advances the workflow's numeric seed inputs by one, so the measured runs do not repeat an identical cached result.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved

Once the three steps are set, click **Run** to start the test. The **Stop** button next to it cancels a test that is in progress.

### Read the results

While the test runs, the panel shows how many runs have finished and the instance logs. When every run finishes, the instance is stopped and the results appear:

- **Fastest run**, **Slowest run**, **Average run**, and **Median run**, in seconds
- **Measured runs** and **Failed runs**: how many runs produced a duration and how many did not
- **Run duration aggregates**: a bar chart comparing the four aggregates (fastest, slowest, average, and median)
- **System information**: compute device, VRAM, RAM, PyTorch version, xFormers version, CPU, CPU cores, operating system, and architecture

A run's duration is the time ComfyUI spent executing the job on the server, not the time you waited for it. Failed runs are counted separately and left out of the statistics.

Two buttons sit with the results: **Open folder** opens the session folder, and **Export results** saves the summary and charts as a PNG image.

## Comparing Runs with Benchmarks

Benchmarks reads the results that Performance Tests saved, so it has nothing to show until at least one test has finished.

### Runs library

The **Runs library** lists every saved run in the results folder, newest first. Its toolbar gives you:

- **Select folder**: point the panel at a different results folder, for example a folder on a shared drive. The default is the folder Performance Tests writes to, see [Where results are stored](#where-results-are-stored).
- **Refresh sessions**: reload the folder after a test finished elsewhere.
- **Search runs**: filter the list by text.
- Dropdown filters for workspace, instance, hardware, and workflow.
- **Properties**: choose which columns the library shows (session, date and time, workflow, instance, workspace, run count, GPU and hardware).

![The Benchmarks runs library with its filters and the table of saved runs](/images/desktop/usage/benchmarks_01_runs_library.png)

### Compare runs

Select two or more runs with the checkboxes, or use **Select all visible runs**. The three newest runs are selected for you when the library loads. A selection opens the **Comparison** section below the library.

Comparison puts one column per selected run next to a set of metric rows: fastest, average, median, and slowest duration, plus the measured run count. One run is the **baseline**. By default it is the first column shown. In the **Speed** view, click a column heading to make that run the baseline instead.

### Relative speed

The comparison has two views, **Duration** and **Speed**, which you switch between in the comparison toolbar. Relative speed belongs to the **Speed** view, and the baseline is chosen there too.

**Relative speed** is the baseline duration divided by a run's duration:

- **1.00×** means the run is the same speed as the baseline
- A factor above 1.00× means the run is **faster** than the baseline
- A factor below 1.00× means the run is **slower** than the baseline

The **Speed** view plots each run on a logarithmic axis with **Slower** to the left and **Faster** to the right, so a 2x and a 4x difference stay readable on the same chart. The **Duration** view draws each run's fastest and slowest result as a line with the average marked. Runs without a usable duration are labelled unavailable.

![The Benchmarks relative speed view with one run as the baseline and another marked slower](/images/desktop/usage/benchmarks_02_relative_speed.png)

### Sort and export

- **Sort comparison** orders the columns by relative speed. **Manual sort** lets you drag columns into your own order, or press Alt+Left / Alt+Right on a focused column.
- **Export results** saves the whole comparison as a PNG image, the quickest way to attach a result to an issue or a chat message.

### Manage sessions

Each test is stored as a session. From the library you can rename a session (**Edit session**) or delete one (**Delete**). Deleting removes every file recorded for that session.

## Where results are stored

Performance Tests creates a session folder when you add a workflow to the panel, named with that moment's timestamp (`YYYYMMDDHHMMSS`):

```
📂 ComfyUI-Shared/
└── 📂 benchmarks/
├── 📂 20260930141522/
│ ├── my_workflow.json
│ ├── jobs.json
│ ├── results.json
│ └── logs.txt
└── 📂 20260930163005/
└── ...
```

| Platform | Default results folder |
|----------|------------------------|
| Windows | `%LOCALAPPDATA%\Comfy-Desktop\ComfyUI-Shared\benchmarks` |
| macOS / Linux | `~/ComfyUI-Shared/benchmarks` |

Each session folder contains:

- the workflow file the panel used
- `jobs.json`: the raw job response from the instance
- `results.json`: the summary the Benchmarks panel reads
- `logs.txt`: the instance console output from the run

Because Benchmarks reads `results.json` from every session folder it finds, copying session folders into the folder Benchmarks points at is enough to compare results from another machine.

Running the same imported workflow again writes into the same session folder and overwrites the results already stored there. To keep a result for comparison, add the workflow to the panel again before the next test.

## Requirements

- A standalone, tracked, or remote instance that Comfy Desktop can launch. The test needs a working ComfyUI instance, so it cannot run against a Cloud instance.
- A workflow the instance can execute, including any models and custom nodes it needs. A workflow you import has to be in API format; the example workflows already are, and Comfy Desktop downloads their models. If the instance rejects the workflow, the test stops and the error appears in the logs. Runs the instance accepts but that fail during execution are counted as failed runs and left out of the duration statistics.
25 changes: 21 additions & 4 deletions ja/installation/desktop/usage/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: "Comfy Desktop の使い方"
description: "Comfy Desktop の使用概要 — 新規インストール、インスタンス管理など"
icon: "book-open"
sidebarTitle: "概要"
translationSourceHash: 651b33ae
translationSourceHash: c728c972
translationFrom: installation/desktop/usage/overview.mdx
translationBlockHashes:
"_intro": d96e3242
"Dashboard Overview": 60e63628
"Dashboard Overview": 4f3fdf2e
"Feedback and Issues": 9304f358
---

Expand All @@ -34,12 +34,29 @@ Comfy Desktop ウィンドウはいくつかの主要エリアに分かれてい

### アプリケーションメニュー

左上のハンバーガーメニュー(☰)からアプリケーションメニュー(File / Edit / View / Window / Help)を開きます。新しいウィンドウの表示、**デスクトップ設定**へのアクセス、Comfy アカウントへの**ログイン**、アプリの終了など、その他のデスクトップレベルの操作も行えます。
左上のハンバーガーメニュー(☰)からアプリケーションメニューを開きます。アプリレベルの操作はすべてここにあります:

<CardGroup cols={1}>
- **Open Dashboard**:Dashboard を新しいウィンドウで開きます。実行中のインスタンスはそのまま動作し続けます。
- **New Instance** と **Add Existing Instance**:新しいインスタンスを作成するか、既存の ComfyUI インストールを登録します。
- **Load Snapshot**:他のユーザーが共有したスナップショットファイルからインスタンスを作成します。
- **Log in**:Comfy アカウントにサインインします。この項目は未サインインのときだけ表示されます。
- **Performance Tests**:インスタンスに対して計測付きのワークフローを実行します。詳しくは[パフォーマンステストとベンチマーク](/ja/installation/desktop/usage/performance-tests)を参照してください。
- **Benchmarks**:保存されたパフォーマンステストの結果を、ハードウェア、ワークフロー、インスタンスごとに比較します。
- **Desktop Settings**:自動更新、プロキシ/ミラー、共有ストレージ、データの保存場所に関するグローバル設定です。
- **Send Feedback**:フィードバックパネルを開きます。
- **Close Window** と **Quit Desktop**:現在のウィンドウを閉じるか、アプリを終了します。インスタンスのウィンドウを閉じるとそのウィンドウが実行している ComfyUI インスタンスが停止し、最後のウィンドウを閉じると Comfy Desktop が終了します。

状況に応じてのみ表示される項目が 2 つあります:ComfyUI ビューがズームされているときの **Reset Zoom (N%)** と、初回セットアップ中の **Skip Onboarding** です。初回セットアップが表示されている間は、**Skip Onboarding** がメニュー内の唯一の項目です。

macOS では、アプリケーションメニューと編集、ウインドウの各メニューを含むシステムメニューバーも維持されます。Windows と Linux のビルドにはシステムメニューバーがありません。

<CardGroup cols={2}>
<Card title="設定" icon="cog" href="/ja/installation/desktop/usage/settings">
グローバル設定:自動更新、プロキシ/ミラー、共有ストレージ、データの保存場所。
</Card>
<Card title="パフォーマンステスト" icon="gauge" href="/ja/installation/desktop/usage/performance-tests">
インスタンス上でワークフローの速度を測定し、ハードウェアごとに実行結果を比較します。
</Card>
</CardGroup>

### インスタンス切り替え
Expand Down
Loading
Loading