|
15 | 15 | - [Quickstart](#quickstart)
|
16 | 16 | - [Features](#features)
|
17 | 17 | - [Config](#config)
|
18 |
| - - [Upload image to AWS S3](#upload-image-to-aws-s3) |
| 18 | + * [Upload image to AWS S3](#upload-image-to-aws-s3) |
19 | 19 | - [Use the Docker image on RunPod](#use-the-docker-image-on-runpod)
|
20 |
| - - [Create your template (optional)](#create-your-template-optional) |
21 |
| - - [Create your endpoint](#create-your-endpoint) |
22 |
| - - [GPU recommendations](#gpu-recommendations) |
| 20 | + * [Create your template (optional)](#create-your-template-optional) |
| 21 | + * [Create your endpoint](#create-your-endpoint) |
| 22 | + * [GPU recommendations](#gpu-recommendations) |
23 | 23 | - [API specification](#api-specification)
|
24 |
| - - [JSON Request Body](#json-request-body) |
25 |
| - - [Fields](#fields) |
26 |
| - - ["input.images"](#inputimages) |
| 24 | + * [JSON Request Body](#json-request-body) |
| 25 | + * [Fields](#fields) |
| 26 | + + ["input.images"](#inputimages) |
27 | 27 | - [Interact with your RunPod API](#interact-with-your-runpod-api)
|
28 |
| - - [Health status](#health-status) |
29 |
| - - [Generate an image](#generate-an-image) |
30 |
| - - [Example request for SDXL with cURL](#example-request-for-sdxl-with-curl) |
| 28 | + * [Health status](#health-status) |
| 29 | + * [Generate an image](#generate-an-image) |
| 30 | + + [Example request for SDXL with cURL](#example-request-for-sdxl-with-curl) |
31 | 31 | - [How to get the workflow from ComfyUI?](#how-to-get-the-workflow-from-comfyui)
|
32 | 32 | - [Bring Your Own Models and Nodes](#bring-your-own-models-and-nodes)
|
33 |
| - - [Network Volume](#network-volume) |
34 |
| - - [Custom Docker Image](#custom-docker-image) |
35 |
| - - [Adding Custom Models](#adding-custom-models) |
36 |
| - - [Adding Custom Nodes](#adding-custom-nodes) |
37 |
| - - [Building the Image](#building-the-image) |
| 33 | + * [Network Volume](#network-volume) |
| 34 | + * [Custom Docker Image](#custom-docker-image) |
| 35 | + + [Adding Custom Models](#adding-custom-models) |
| 36 | + + [Adding Custom Nodes](#adding-custom-nodes) |
| 37 | + + [Building the Image](#building-the-image) |
38 | 38 | - [Local testing](#local-testing)
|
39 |
| - - [Setup](#setup) |
40 |
| - - [Setup for Windows](#setup-for-windows) |
41 |
| - - [Testing the RunPod handler](#testing-the-runpod-handler) |
42 |
| - - [Local API](#local-api) |
43 |
| - - [Access the local Worker API](#access-the-local-worker-api) |
44 |
| - - [Access local ComfyUI](#access-local-comfyui) |
| 39 | + * [Setup](#setup) |
| 40 | + + [Setup for Windows](#setup-for-windows) |
| 41 | + * [Testing the RunPod handler](#testing-the-runpod-handler) |
| 42 | + * [Local API](#local-api) |
| 43 | + + [Access the local Worker API](#access-the-local-worker-api) |
| 44 | + + [Access local ComfyUI](#access-local-comfyui) |
45 | 45 | - [Automatically deploy to Docker hub with GitHub Actions](#automatically-deploy-to-docker-hub-with-github-actions)
|
46 | 46 | - [Acknowledgments](#acknowledgments)
|
47 | 47 |
|
|
52 | 52 | ## Quickstart
|
53 | 53 |
|
54 | 54 | - 🐳 Choose one of the five available images for your serverless endpoint:
|
55 |
| - - `runpod/worker-comfyui:3.6.0-base`: doesn't contain anything, just a clean ComfyUI |
56 |
| - - `runpod/worker-comfyui:3.6.0-flux1-schnell`: contains the checkpoint, text encoders and VAE for [FLUX.1 schnell](https://huggingface.co/black-forest-labs/FLUX.1-schnell) |
57 |
| - - `runpod/worker-comfyui:3.6.0-flux1-dev`: contains the checkpoint, text encoders and VAE for [FLUX.1 dev](https://huggingface.co/black-forest-labs/FLUX.1-dev) |
58 |
| - - `runpod/worker-comfyui:3.6.0-sdxl`: contains the checkpoint and VAE for [Stable Diffusion XL](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0) |
59 |
| - - `runpod/worker-comfyui:3.6.0-sd3`: contains the checkpoint for [Stable Diffusion 3 medium](https://huggingface.co/stabilityai/stable-diffusion-3-medium) |
| 55 | + - `runpod/worker-comfyui:4.1.0-base`: doesn't contain anything, just a clean ComfyUI |
| 56 | + - `runpod/worker-comfyui:4.1.0-flux1-schnell`: contains the checkpoint, text encoders and VAE for [FLUX.1 schnell](https://huggingface.co/black-forest-labs/FLUX.1-schnell) |
| 57 | + - `runpod/worker-comfyui:4.1.0-flux1-dev`: contains the checkpoint, text encoders and VAE for [FLUX.1 dev](https://huggingface.co/black-forest-labs/FLUX.1-dev) |
| 58 | + - `runpod/worker-comfyui:4.1.0-sdxl`: contains the checkpoint and VAE for [Stable Diffusion XL](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0) |
| 59 | + - `runpod/worker-comfyui:4.1.0-sd3`: contains the checkpoint for [Stable Diffusion 3 medium](https://huggingface.co/stabilityai/stable-diffusion-3-medium) |
60 | 60 | - ℹ️ [Use the Docker image on RunPod](#use-the-docker-image-on-runpod)
|
61 | 61 | - 🧪 Pick an [example workflow](./test_resources/workflows/) & [send it to your deployed endpoint](#interact-with-your-runpod-api)
|
62 | 62 |
|
|
68 | 68 | - Returned as base64-encoded string (default)
|
69 | 69 | - Uploaded to AWS S3 ([if AWS S3 is configured](#upload-image-to-aws-s3))
|
70 | 70 | - There are a few different Docker images to choose from:
|
71 |
| - - `runpod/worker-comfyui:3.6.0-flux1-schnell`: contains the [flux1-schnell.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-schnell) checkpoint, the [clip_l.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/clip_l.safetensors) + [t5xxl_fp8_e4m3fn.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/t5xxl_fp8_e4m3fn.safetensors) text encoders and [ae.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-schnell/resolve/main/ae.safetensors) VAE for FLUX.1-schnell |
72 |
| - - `runpod/worker-comfyui:3.6.0-flux1-dev`: contains the [flux1-dev.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-dev) checkpoint, the [clip_l.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/clip_l.safetensors) + [t5xxl_fp8_e4m3fn.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/t5xxl_fp8_e4m3fn.safetensors) text encoders and [ae.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-dev/resolve/main/ae.safetensors) VAE for FLUX.1-dev |
73 |
| - - `runpod/worker-comfyui:3.6.0-sdxl`: contains the checkpoints and VAE for Stable Diffusion XL |
| 71 | + - `runpod/worker-comfyui:4.1.0-flux1-schnell`: contains the [flux1-schnell.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-schnell) checkpoint, the [clip_l.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/clip_l.safetensors) + [t5xxl_fp8_e4m3fn.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/t5xxl_fp8_e4m3fn.safetensors) text encoders and [ae.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-schnell/resolve/main/ae.safetensors) VAE for FLUX.1-schnell |
| 72 | + - `runpod/worker-comfyui:4.1.0-flux1-dev`: contains the [flux1-dev.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-dev) checkpoint, the [clip_l.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/clip_l.safetensors) + [t5xxl_fp8_e4m3fn.safetensors](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/t5xxl_fp8_e4m3fn.safetensors) text encoders and [ae.safetensors](https://huggingface.co/black-forest-labs/FLUX.1-dev/resolve/main/ae.safetensors) VAE for FLUX.1-dev |
| 73 | + - `runpod/worker-comfyui:4.1.0-sdxl`: contains the checkpoints and VAE for Stable Diffusion XL |
74 | 74 | - Checkpoint: [sd_xl_base_1.0.safetensors](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)
|
75 | 75 | - VAEs:
|
76 | 76 | - [sdxl_vae.safetensors](https://huggingface.co/stabilityai/sdxl-vae/)
|
77 | 77 | - [sdxl-vae-fp16-fix](https://huggingface.co/madebyollin/sdxl-vae-fp16-fix/)
|
78 |
| - - `runpod/worker-comfyui:3.6.0-sd3`: contains the [sd3_medium_incl_clips_t5xxlfp8.safetensors](https://huggingface.co/stabilityai/stable-diffusion-3-medium) checkpoint for Stable Diffusion 3 medium |
| 78 | + - `runpod/worker-comfyui:4.1.0-sd3`: contains the [sd3_medium_incl_clips_t5xxlfp8.safetensors](https://huggingface.co/stabilityai/stable-diffusion-3-medium) checkpoint for Stable Diffusion 3 medium |
79 | 79 | - [Bring your own models](#bring-your-own-models)
|
80 | 80 | - Based on [Ubuntu + NVIDIA CUDA](https://hub.docker.com/r/nvidia/cuda)
|
81 | 81 |
|
@@ -109,7 +109,7 @@ This is only needed if you want to upload the generated picture to AWS S3. If yo
|
109 | 109 | - In the dialog, configure:
|
110 | 110 | - Template Name: `worker-comfyui` (it can be anything you want)
|
111 | 111 | - Template Type: serverless (change template type to "serverless")
|
112 |
| - - Container Image: `<dockerhub_username>/<repository_name>:tag`, in this case: `runpod/worker-comfyui:3.6.0-sd3` (or `-base` for a clean image or `-sdxl` for Stable Diffusion XL or `-flex1-schnell` for FLUX.1 schnell) |
| 112 | + - Container Image: `<dockerhub_username>/<repository_name>:tag`, in this case: `runpod/worker-comfyui:4.1.0-sd3` (or `-base` for a clean image or `-sdxl` for Stable Diffusion XL or `-flex1-schnell` for FLUX.1 schnell) |
113 | 113 | - Container Registry Credentials: You can leave everything as it is, as this repo is public
|
114 | 114 | - Container Disk: `20 GB`
|
115 | 115 | - (optional) Environment Variables: [Configure S3](#upload-image-to-aws-s3)
|
|
0 commit comments