From 407405fbcfedae851c6f9783fad362607baa0c13 Mon Sep 17 00:00:00 2001 From: YAN Wenkun Date: Sat, 10 Aug 2024 16:17:17 +0800 Subject: [PATCH] update docs --- README.adoc | 53 ++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/README.adoc b/README.adoc index 0270f1d..dc2d1e7 100644 --- a/README.adoc +++ b/README.adoc @@ -8,41 +8,46 @@ that runs https://github.com/comfyanonymous/ComfyUI[ComfyUI] - a Stable Diffusion GUI powering node-based workflow. +## Quick Start - NVIDIA GPU -## Major Update July 2024 - -* alias `latest` as `cu121` -* alias `megapak` as `cu121-megapak` -* add `cu124-megapak` -* add `comfy3d-pt22`, `comfy3d-pt23` -* remove support for comfy3d in other images +```sh +mkdir -p storage -* More detailed documentation coming soon... +docker run -it --rm \ + --name comfyui \ + --gpus all \ + -p 8188:8188 \ + -v "$(pwd)"/storage:/home/runner \ + -e CLI_ARGS="" \ + yanwk/comfyui-boot:cu121 +``` ## Image tags * link:cu121/README.adoc[`cu121`, `latest`] -** Recommended for most scenarios. Especially for users who are: -*** new to ComfyUI -*** new to Docker -*** using WSL2 Docker -** Not recommended for Podman or rootless users (use tags below). +** Recommended for those trying ComfyUI for the first time. +** Equipped with many dependencies. Starts with ComfyUI core only. +** Using a low-privilege user within the container (easy for WSL2 deploy). +** Not recommended for Podman or rootless deploy (use `megapak` instead). +** Using CUDA 12.1 + Python 3.11. * link:cu121-megapak/README.adoc[`cu121-megapak`, `megapak`] -** Big all-in-one, including dev kits. Ideal for "heavy" usage. +** All-in-one bundle, including dev kits. +** Using 'root' user within the container (easy for rootless deploy). ** Using CUDA 12.1 + Python 3.11. * link:cu124-megapak/README.adoc[`cu124-megapak`] -** Similar to the above one, but using CUDA 12.4 + Python 3.12. -** May perform better on newer GPUs. +** All-in-one bundle, including dev kits. +** Using 'root' user within the container (easy for rootless deploy). +** Using CUDA 12.4 + Python 3.12. May perform better on newer GPUs. * link:rocm/README.adoc[`rocm`] -** For AMD GPUs. +** For AMD GPUs with ROCm. * link:comfy3d-pt22/README.adoc[`comfy3d-pt22`] @@ -51,9 +56,23 @@ https://github.com/MrForExample/ComfyUI-3D-Pack[ComfyUI-3D-Pack] ** Running a classic version of Comfy3D based on PyTorch 2.2 * link:comfy3d-pt23/README.adoc[`comfy3d-pt23`] + +** Dedicated for +https://github.com/MrForExample/ComfyUI-3D-Pack[ComfyUI-3D-Pack] ** Running a newer version of Comfy3D based on PyTorch 2.3 +## Major Update July 2024 + +* alias `latest` as `cu121` +* alias `megapak` as `cu121-megapak` +* add `cu124-megapak` +* add `comfy3d-pt22`, `comfy3d-pt23` +* remove support for comfy3d in other images + +* More detailed documentation coming soon... + + ## License link:LICENSE[Mulan Public Licenseļ¼ŒVersion 2]