diff --git a/README.md b/README.md index 035f67c..fcb8b2b 100644 --- a/README.md +++ b/README.md @@ -63,12 +63,16 @@ git clone https://github.com/lodestone-rock/ComfyUI_FluxMod.git ## Node Information -| Node | Description | Options | -| ----------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| FluxModCheckpointLoader | Primary checkpoint loading node | • **ckpt_name**: Original Flux model path
• **guidance_name**: Modulation addon path
• **quant_mode**: Quantization selection | +| Node | Description | Options | +| ----------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| FluxModCheckpointLoader | Primary checkpoint loading node | • **ckpt_name**: Original Flux model path
• **guidance_name**: Modulation addon path
• **quant_mode**: Quantization selection | +| KSamplerMod | Modified KSampler for 8-bit quantization | • **activation_casting**: Switch between bf16 and fp16 | +| SkipLayerForward | Skip specific Flux layers | • **skip_mmdit_layers**: Which MMDiT layer to skip
• **skip_dit_layers**: Which DIT layers to skip (-1 to disable) | ## Usage +> ⚠️ **Important**: When using `float8_e4m3fn` or `float8_e5m2` quantization modes, you must use the `KSamplerMod` node instead of the regular KSampler. This requirement does not apply when using `bf16` mode. + 1. Double click workspace → search "FluxModCheckpointLoader" 2. Select your Flux model in `ckpt_name` 3. Select modulation addon in `guidance_name` @@ -82,8 +86,8 @@ git clone https://github.com/lodestone-rock/ComfyUI_FluxMod.git | Mode | Recommended GPU | VRAM Usage | Recommended | | ------------- | --------------- | ---------- | ----------- | | bf16 | 24GB+ | ~20GB | ✅ | -| float8_e4m3fn | 12-16GB | ~10GB | ✅ | -| float8_e5m2 | 12-16GB | ~10GB | ❌ | +| float8_e4m3fn | 12-16GB | ~13GB | ✅ | +| float8_e5m2 | 12-16GB | ~13GB | ❌ | ## Examples @@ -92,7 +96,7 @@ Here are some comparison examples showing the output quality between the origina
Example 1: Art Studio Scene -![Comparison 1](comparison_1.png) +![Comparison 1](https://github.com/lodestone-rock/flux-mod/blob/main/examples/comparison_1.png) **Prompt:** A photo of an art studio with a cabin design, there are paint splatters over much of the wooden furnishing, there are old style windows overlooking a lake outside with a slanted ceiling with large skylights letting in natural light. There is an easel with a half-finished painting. There is a paint palette that is placed on a wooden table. There are dust speckles floating in the air illuminated by the golden hour light. There is a woman standing in a colourful dress and ruby red shoes who is painting in front of the easel.
@@ -100,7 +104,7 @@ Here are some comparison examples showing the output quality between the origina
Example 2: Glass Rainbow Room -![Comparison 2](comparison_2.png) +![Comparison 2](https://github.com/lodestone-rock/flux-mod/blob/main/examples/comparison_2.png) **Prompt:** A photo of a room with the walls made of millions of pieces of shattered glass in rainbow colours, there is light shining through the glass causing a huge dispersion of colours across the scene. The light is refracting off all the glass in the room illuminating the room with bright hues from the colored glass.
@@ -108,7 +112,7 @@ Here are some comparison examples showing the output quality between the origina
Example 3: Balloon Text -![Comparison 3](comparison_3.png) +![Comparison 3](https://github.com/lodestone-rock/flux-mod/blob/main/examples/comparison_3.png) **Prompt:** Text made out of foil balloons saying "Hi there fellow traveller, make sure to star this GitHub! Thank you!"
@@ -116,7 +120,7 @@ Here are some comparison examples showing the output quality between the origina
Example 4: Space Pirate Ship -![Comparison 4](comparison_4.png) +![Comparison 4](https://github.com/lodestone-rock/flux-mod/blob/main/examples/comparison_4.png) **Prompt:** Concept art of a ornately decorated pirate ship in outer space that is floating through a nebula with spectacular blue and purple hues. There is dust that is around the ship as it sails through the cosmos, dispersing at the bow of the ship.
@@ -124,7 +128,7 @@ Here are some comparison examples showing the output quality between the origina
Example 5: Detailed Room Scene -![Comparison 5](comparison_5.png) +![Comparison 5](https://github.com/lodestone-rock/flux-mod/blob/main/examples/comparison_5.png) **Prompt:** A scene with a blue block and a red ball that is placed on top of the blue block. In the background there is a green door with pink walls. To the left of the door, there is a painting on the wall which is showing a scene of an ocean wave that is orange. To the right of the door, there is a portrait of a cat that has purple eyes. There is a window to the right side of the scene that is letting in light that has a shade of blue, illuminating the carpet which has a cyan hue. There is a bed on the left side of the room that has a white pillow with orange sheets. There is a bedside table with an orange lamp and a phone that is placed on top of it. To the right side of the beside table, there is a green bin with a red recycling logo on it.