summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index d88e388..1eab39c 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,15 @@
## セットアップ
-1. `config.example.toml` をコピーし、モデルの root とファイル名を設定します。
-2. `uv sync` を実行します。
-3. `uv run mcp-sd15 --config path/to/config.toml` で起動します。
+1. NVIDIA driverがCUDA 13.2対応PyTorchを実行できることを`nvidia-smi`で確認します。
+2. `config.example.toml` をコピーし、モデルの root とファイル名を設定します。
+3. `uv sync` を実行します。PyTorchは専用indexからCUDA 13.2版が導入されます。
+4. `uv run mcp-sd15 --config path/to/config.toml` で起動します。
モデルは `<root>/checkpoints`、`vae`、`lora`、`controlnet` からだけ読み込みます。
+VAE componentは生成に常に必要です。`model.vae`を省略した場合はcheckpoint内蔵VAEを使い、
+指定した場合だけ外部VAEへ置き換えます。設定されたLoRAは起動時にすべてロードされ、3つの
+生成ツールに共通して適用されます。MCP呼び出しごとのLoRA切替には対応しません。
Depth/Openpose の annotator 重みは `controlnet_aux` のローカルキャッシュに事前配置して
ください。推論時のダウンロードは行いません。
@@ -20,3 +24,11 @@ mask は白い領域が再生成対象です。出力は PNG の画像 content ã
GPU を使わないテストは `uv run pytest`、lint は `uv run ruff check .`、型検査は
`uv run pyright` で実行できます。実モデルの smoke test は環境依存のため自動テストには
含めていません。
+
+実GPUとMCP経路を使う`generate_image` smoke testは次のように実行できます。
+
+```powershell
+uv run python script\smoke_generate_image.py `
+ --config data\config.generate-image.toml `
+ --output data\outputs\generate-image-mcp-512.png
+```