README_from_modelscope.md

---
frameworks:
- Pytorch
license: Apache License 2.0
tags: []
tasks:
- text-to-image-synthesis
---

# Templates-局部重绘（FLUX.2-klein-base-4B）

本模型是 [DiffSynth-Studio](https://github.com/modelscope/DiffSynth-Studio) 开源的 Diffusion Templates 系列模型之一。该模型专为局部重绘设计，能够接收原图和Mask图，并根据自然语言提示词在遮罩区域内生成全新的内容，同时无缝融合周围未被遮罩的图像背景。

## 效果展示

| Reference | Prompt | Mask | Generated |
|:---:|:---|:---:|:---:|
| ![](./assets/cat_base.jpg) | An orange cat is sitting on a stone. | ![](./assets/cat_mask_1.jpg) | ![](./assets/cat_Inpaint_1.jpg) |
| ![](./assets/cat_base.jpg) | A cat wearing sunglasses is sitting on a stone. | ![](./assets/cat_mask_2.jpg) | ![](./assets/cat_Inpaint_2.jpg) |

| Reference | Prompt | Mask | Generated |
|:---:|:---|:---:|:---:|
| ![](./assets/girl_base.jpg) | A beautiful young woman wearing a woven straw hat with a ribbon standing in a sunflower field. | ![](./assets/girl_mask_1.jpg) | ![](./assets/girl_Inpaint_1.jpg) |
| ![](./assets/girl_base.jpg) | A beautiful young woman wearing an elegant white dress standing in a glowing sunflower field. | ![](./assets/girl_mask_2.jpg) | ![](./assets/girl_Inpaint_2.jpg) |

| Reference | Prompt | Mask | Generated |
|:---:|:---|:---:|:---:|
| ![](./assets/room_base.jpg) | A sleek glass vase with a single blooming white lily and an open minimalist art book resting on the circular white marble coffee table. | ![](./assets/room1.jpg) | ![](./assets/room_Inpaint_1.jpg) |
| ![](./assets/room_base.jpg) | A large, minimalist flower painting hanging on the clean off-white wall above the sofa, soft shadows. | ![](./assets/room2.jpg) | ![](./assets/room_Inpaint_2.jpg) |

## 推理代码

* 安装 [DiffSynth-Studio](https://github.com/modelscope/DiffSynth-Studio)

```
git clone https://github.com/modelscope/DiffSynth-Studio.git
cd DiffSynth-Studio
pip install -e .
```

* 直接推理，需 40G 显存

```python
from diffsynth.diffusion.template import TemplatePipeline
from diffsynth.pipelines.flux2_image import Flux2ImagePipeline, ModelConfig
import torch
from modelscope import dataset_snapshot_download
from PIL import Image

pipe = Flux2ImagePipeline.from_pretrained(
    torch_dtype=torch.bfloat16,
    device="cuda",
    model_configs=[
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-base-4B", origin_file_pattern="transformer/*.safetensors"),
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="text_encoder/*.safetensors"),
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="vae/diffusion_pytorch_model.safetensors"),
    ],
    tokenizer_config=ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="tokenizer/"),
)
template = TemplatePipeline.from_pretrained(
    torch_dtype=torch.bfloat16,
    device="cuda",
    model_configs=[ModelConfig(model_id="DiffSynth-Studio/Template-KleinBase4B-Inpaint")],
)
dataset_snapshot_download(
    "DiffSynth-Studio/examples_in_diffsynth",
    allow_file_pattern=["templates/*"],
    local_dir="data/examples",
)
image = template(
    pipe,
    prompt="An orange cat is sitting on a stone.",
    seed=0, cfg_scale=4, num_inference_steps=50,
    template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_1.jpg"),
        "force_inpaint": True,
    }],
    negative_template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_1.jpg"),
    }],
)
image.save("image_Inpaint_1.jpg")
image = template(
    pipe,
    prompt="A cat wearing sunglasses is sitting on a stone.",
    seed=0, cfg_scale=4, num_inference_steps=50,
    template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_2.jpg"),
    }],
    negative_template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_2.jpg"),
    }],
)
image.save("image_Inpaint_2.jpg")
```

* 开启惰性加载和显存管理，需 24G 显存

```python
from diffsynth.diffusion.template import TemplatePipeline
from diffsynth.pipelines.flux2_image import Flux2ImagePipeline, ModelConfig
import torch
from modelscope import dataset_snapshot_download
from PIL import Image

vram_config = {
    "offload_dtype": "disk",
    "offload_device": "disk",
    "onload_dtype": torch.float8_e4m3fn,
    "onload_device": "cpu",
    "preparing_dtype": torch.float8_e4m3fn,
    "preparing_device": "cuda",
    "computation_dtype": torch.bfloat16,
    "computation_device": "cuda",
}
pipe = Flux2ImagePipeline.from_pretrained(
    torch_dtype=torch.bfloat16,
    device="cuda",
    model_configs=[
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-base-4B", origin_file_pattern="transformer/*.safetensors", **vram_config),
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="text_encoder/*.safetensors", **vram_config),
        ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="vae/diffusion_pytorch_model.safetensors"),
    ],
    tokenizer_config=ModelConfig(model_id="black-forest-labs/FLUX.2-klein-4B", origin_file_pattern="tokenizer/"),
    vram_limit=torch.cuda.mem_get_info("cuda")[1] / (1024 ** 3) - 0.5,
)
template = TemplatePipeline.from_pretrained(
    torch_dtype=torch.bfloat16,
    device="cuda",
    model_configs=[ModelConfig(model_id="DiffSynth-Studio/Template-KleinBase4B-Inpaint")],
    lazy_loading=True,
)
dataset_snapshot_download(
    "DiffSynth-Studio/examples_in_diffsynth",
    allow_file_pattern=["templates/*"],
    local_dir="data/examples",
)
image = template(
    pipe,
    prompt="An orange cat is sitting on a stone.",
    seed=0, cfg_scale=4, num_inference_steps=50,
    template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_1.jpg"),
        "force_inpaint": True,
    }],
    negative_template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_1.jpg"),
    }],
)
image.save("image_Inpaint_1.jpg")
image = template(
    pipe,
    prompt="A cat wearing sunglasses is sitting on a stone.",
    seed=0, cfg_scale=4, num_inference_steps=50,
    template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_2.jpg"),
    }],
    negative_template_inputs = [{
        "image": Image.open("data/examples/templates/image_reference.jpg"),
        "mask": Image.open("data/examples/templates/image_mask_2.jpg"),
    }],
)
image.save("image_Inpaint_2.jpg")
```

## 训练代码

安装 DiffSynth-Studio 后，使用以下脚本可开启训练，更多信息请参考 [DiffSynth-Studio 文档](https://diffsynth-studio-doc.readthedocs.io/zh-cn/latest/)。

```shell
modelscope download --dataset DiffSynth-Studio/diffsynth_example_dataset --include "flux2/Template-KleinBase4B-Inpaint/*" --local_dir ./data/diffsynth_example_dataset

accelerate launch examples/flux2/model_training/train.py \
  --dataset_base_path data/diffsynth_example_dataset/flux2/Template-KleinBase4B-Inpaint \
  --dataset_metadata_path data/diffsynth_example_dataset/flux2/Template-KleinBase4B-Inpaint/metadata.jsonl \
  --extra_inputs "template_inputs" \
  --max_pixels 1048576 \
  --dataset_repeat 50 \
  --model_id_with_origin_paths "black-forest-labs/FLUX.2-klein-4B:text_encoder/*.safetensors,black-forest-labs/FLUX.2-klein-base-4B:transformer/*.safetensors,black-forest-labs/FLUX.2-klein-4B:vae/diffusion_pytorch_model.safetensors" \
  --template_model_id_or_path "DiffSynth-Studio/Template-KleinBase4B-Inpaint:" \
  --tokenizer_path "black-forest-labs/FLUX.2-klein-4B:tokenizer/" \
  --learning_rate 1e-4 \
  --num_epochs 2 \
  --remove_prefix_in_ckpt "pipe.template_model." \
  --output_path "./models/train/Template-KleinBase4B-Inpaint_full" \
  --trainable_models "template_model" \
  --use_gradient_checkpointing \
  --find_unused_parameters
```