From d00790b190f5aefa83bd3ac234e323b77170c198 Mon Sep 17 00:00:00 2001
From: YAN Wenkun <code@yanwk.fun>
Date: Wed, 11 Sep 2024 10:02:43 +0800
Subject: [PATCH] 'nightly' add comments

---
 nightly/Dockerfile  | 33 +++++++++++++++++++++++++++++++++
 nightly/README.adoc | 10 ++++++++--
 2 files changed, 41 insertions(+), 2 deletions(-)

diff --git a/nightly/Dockerfile b/nightly/Dockerfile
index 77c9b5c..0d29b11 100644
--- a/nightly/Dockerfile
+++ b/nightly/Dockerfile
@@ -65,7 +65,9 @@ RUN --mount=type=cache,target=/root/.cache/pip \
         --pre torch torchvision torchaudio \
         --index-url https://download.pytorch.org/whl/nightly/cu124
 
+################################################################################
 # Dependencies
+
 # RUN --mount=type=cache,target=/root/.cache/pip \
 #     pip install \
 # accelerate \
@@ -130,6 +132,37 @@ RUN --mount=type=cache,target=/root/.cache/pip \
 #         mediapipe \
 #     && pip list
 
+################################################################################
+# # Build xFormers
+
+# # https://arnon.dk/matching-sm-architectures-arch-and-gencode-for-various-nvidia-cards/
+# ARG TORCH_CUDA_ARCH_LIST="5.2+PTX;6.0;6.1+PTX;7.0+PTX;7.5;8.0;8.6+PTX;8.9+PTX"
+
+# # Limit max concurrent build jobs. Not set here.
+# ARG MAX_JOBS
+
+# RUN mkdir -p /BUILD/wheels
+
+# RUN --mount=type=cache,target=/root/.cache/pip \
+#     pip install \
+#         -r https://raw.githubusercontent.com/facebookresearch/xformers/main/requirements.txt
+
+# RUN git clone --depth=1 --no-tags --recurse-submodules --shallow-submodules \
+#         https://github.com/facebookresearch/xformers.git \
+#         /BUILD/xformers
+
+# WORKDIR /BUILD/xformers
+
+# RUN --mount=type=cache,target=/root/.cache/pip \
+#     --mount=type=cache,target=/BUILD/xformers/build \
+#     --mount=type=cache,target=/BUILD/xformers/dist \
+#     python3 setup.py bdist_wheel -d /BUILD/wheels
+
+# RUN --mount=type=cache,target=/root/.cache/pip \
+#     pip install /BUILD/wheels/*.whl
+
+################################################################################
+
 RUN du -ah /root \
     && find /root/ -mindepth 1 -delete \
     && df -h
diff --git a/nightly/README.adoc b/nightly/README.adoc
index fb72eda..2d10491 100644
--- a/nightly/README.adoc
+++ b/nightly/README.adoc
@@ -8,8 +8,14 @@ https://hub.docker.com/r/yanwk/comfyui-boot/tags?name=nightly[View on <Docker Hu
 
 * This image won't download ComfyUI or any models. Please prepare your ComfyUI suite before running the container.
 
-* `xFormers` is not installed in this image.
-It requires building from source in order to use it with PyTorch nightly. And building xFormers (with comprehensive build targets) on GitHub Actions (unpaid version) would often result in halt. So for now it's not included.
+* Part of the `Dockerfile` is commented out due to CI limitation:
+
+** Only basic dependencies for running ComfyUI is installed. Otherwise the image would be too big that GitHub Actions would throw IOException.
+
+** `xFormers` is not installed in this image.
+It requires building from source in order to use it with PyTorch nightly. And building xFormers (with comprehensive build targets) on GitHub Actions would often result in halt (maybe just unpaid version).
+
+** If you build the image by yourself, you can uncomment the lines in `Dockerfile`, for a bigger, yet more comprehensive image.
 
 ## Running