docs: add Comfy-Cli and Modal example (#68, #69)

Co-Authored-By: the-dream-machine <[email protected]>

Author: Chaoses-Ib

README.md

@@ -48,14 +48,18 @@ It has the following use cases:
 
 ## Installation
 ### With ComfyUI
-Install [ComfyUI](https://github.com/comfyanonymous/ComfyUI#installing) first. And then run the following commands:
+Install ComfyUI first, see [Installing](https://github.com/comfyanonymous/ComfyUI#installing) or use [Comfy-Cli](https://github.com/Comfy-Org/comfy-cli) to install:
+```sh
+python -m pip install comfy-cli
+comfy --here install
+```
+And then run the following commands to install ComfyScript:
 ```sh
 cd ComfyUI/custom_nodes
 git clone https://github.com/Chaoses-Ib/ComfyScript.git
 cd ComfyScript
 python -m pip install -e ".[default]"
 ```
-(If you see `ERROR: File "setup.py" or "setup.cfg" not found`, run `python -m pip install -U pip` first.)
 
 Update:
 ```sh
@@ -64,6 +68,8 @@ git pull
 python -m pip install -e ".[default]"
 ```
 
+`[default]` is necessary to install common dependencies. See [`pyproject.toml`](pyproject.toml) for other options. If no option is specified, ComfyScript will be installed without any dependencies.
+
 ### With ComfyUI package
 Install [ComfyUI package](https://github.com/hiddenswitch/ComfyUI) first:
 - If PyTorch is not installed:
@@ -83,13 +89,14 @@ Install/update ComfyScript:
 python -m pip install -U "comfy-script[default]"
 ```
 
-`[default]` is necessary to install common dependencies. See [`pyproject.toml`](pyproject.toml) for other options. If no option is specified, `comfy-script` will be installed without any dependencies.
-
 If there are problems with the latest ComfyUI package, one can use the last tested version:
 ```
 python -m pip install --no-build-isolation git+https://github.com/hiddenswitch/ComfyUI.git@e8eab4dbc6487a14a0c548a806b0b772e274e3df
 ```
 
+### Containers
+- [Modal](examples/modal.py) by @the-dream-machine (ComfyUI + Comfy-Cli)
+
 ### Others
 See [troubleshooting](docs/README.md#troubleshooting) if you encountered any problems. To use ComfyScript without installed ComfyUI, see [only ComfyScript package](docs/README.md#only-comfyscript-package) for details. To uninstall, see [uninstallation](docs/README.md#uninstallation).
 
@@ -164,7 +171,7 @@ with Workflow():
     SaveImage(image, 'ComfyUI')
 ```
 
-A Jupyter Notebook example is available at [`examples/runtime.ipynb`](examples/runtime.ipynb). (Files under `examples` directory will be ignored by Git and you can put your personal notebooks there.)
+A Jupyter Notebook example is available at [`examples/runtime.ipynb`](examples/runtime.ipynb).
 
 - [Type stubs](https://typing.readthedocs.io/en/latest/source/stubs.html) will be generated at `comfy_script/runtime/nodes.pyi` after loading. Mainstream code editors (e.g. [VS Code](https://code.visualstudio.com/docs/languages/python)) can use them to help with coding:
 

docs/README.md

@@ -2,6 +2,11 @@
 ## Installation
 See [README](../README.md#installation) for basic ways to install.
 
+You can use the following command to install ComfyScript with the latest commit that may has not been released to PyPI yet:
+```sh
+python -m pip install "comfy-script[default] @ git+https://github.com/Chaoses-Ib/ComfyScript.git"
+```
+
 ### Only ComfyScript package
 Install/update:
 ```sh

examples/modal.py

@@ -0,0 +1,77 @@
+'''
+An example script for setting up and running ComfyUI and ComfyScript with Modal.
+
+Be careful if you want to replace the official ComfyUI with the comfyui package, Modal does not work well with it: https://github.com/Chaoses-Ib/ComfyScript/issues/69
+
+Author: @the-dream-machine
+'''
+
+import subprocess
+import modal
+
+image = (
+    modal.Image.debian_slim(python_version="3.12.5")
+    .apt_install("git")
+    .pip_install("comfy-cli==1.1.6")
+    # use comfy-cli to install the ComfyUI repo and its dependencies
+    .run_commands("comfy --skip-prompt install --nvidia")
+    # download all models and custom nodes required in your workflow
+    .run_commands(
+        "comfy --skip-prompt model download --url https://civitai.com/api/download/models/290640 --relative-path models/checkpoints"
+    )
+    .run_commands(
+        "cd /root/comfy/ComfyUI/custom_nodes && git clone https://github.com/Chaoses-Ib/ComfyScript.git",
+        "cd /root/comfy/ComfyUI/custom_nodes/ComfyScript && python -m pip install -e '.[default]'",
+    )
+)
+
+app = modal.App("pony_diffusion_2")
+
+# Optional: serve the UI
+@app.function(
+    allow_concurrent_inputs=10,
+    concurrency_limit=1,
+    container_idle_timeout=30,
+    timeout=1800,
+    gpu="T4",
+)
+@modal.web_server(8000, startup_timeout=60)
+def ui():
+    _web_server = subprocess.Popen("comfy launch -- --listen 0.0.0.0 --port 8000", shell=True)
+
+@app.cls(gpu="T4", container_idle_timeout=120, image=image)
+class Model:
+    @modal.build()
+    def build(self):
+        print("🛠️ Building container...")
+
+    @modal.enter()
+    def enter(self):
+        print("✅ Entering container...")
+        from comfy_script.runtime import load
+        load()
+
+    @modal.exit()
+    def exit(self):
+        print("🧨 Exiting container...")
+
+    @modal.method()
+    def generate_image(self, prompt:str):
+        print("🎨 Generating image...")
+        from comfy_script.runtime import Workflow
+        from comfy_script.runtime.nodes import CheckpointLoaderSimple, CLIPTextEncode, EmptyLatentImage, KSampler, VAEDecode, SaveImage, CivitAICheckpointLoader
+
+        with Workflow(wait=True):
+            model, clip, vae = CivitAICheckpointLoader('https://civitai.com/models/101055?modelVersionId=128078')
+            # model, clip, vae = CheckpointLoaderSimple("ponyDiffusionV6XL_v6StartWithThisOne.safetensors")
+            conditioning = CLIPTextEncode('beautiful scenery nature glass bottle landscape, , purple galaxy bottle,', clip)
+            conditioning2 = CLIPTextEncode('text, watermark', clip)
+            latent = EmptyLatentImage(512, 512, 1)
+            latent = KSampler(model, 156680208700286, 20, 8, 'euler', 'normal', conditioning, conditioning2, latent, 1)
+            image = VAEDecode(latent, vae)
+            result = SaveImage(image, 'ComfyUI')
+            print("result", result)
+
+@app.local_entrypoint()
+def main(prompt: str):
+    Model().generate_image.remote(prompt)