Update README.md

README.md

@@ -5,4 +5,70 @@ language:
 base_model:
 - black-forest-labs/FLUX.1-dev
 pipeline_tag: image-to-image
----
+---
+
+# HiFi-Inpaint
+
+HiFi-Inpaint 是一个基于 FLUX.1-dev 的图像修复/补全（inpainting）推理工程，提供 `infer.py` 一键跑通的 demo 流程（参考图 + 带遮罩输入 → 输出修复结果）。
+
+## 环境安装
+
+```bash
+conda create -n hifi-inpaint python=3.10 -y
+conda activate hifi-inpaint
+pip install -r requirements.txt
+```
+
+## 模型权重准备
+
+1) 从 Hugging Face 下载 FLUX.1-dev：
+- https://huggingface.co/black-forest-labs/FLUX.1-dev
+
+2) 下载 HiFi-Inpaint 的 LoRA 权重（由我们提供）。
+
+将权重放到如下目录（目录不存在可自行创建）：
+
+- `./ckpts/FLUX.1-dev`
+- `./ckpts/HiFi-Inpaint`
+
+仓库中 `ckpts/` 仅保留空目录占位文件，不包含任何模型权重。
+
+推荐目录结构：
+
+```text
+ckpts/
+  FLUX.1-dev/
+    (base model files...)
+  HiFi-Inpaint/
+    pytorch_lora_weights.safetensors
+```
+
+## 推理（Inference）
+
+直接运行：
+
+```bash
+python infer.py
+```
+
+默认参数（可在命令行覆盖）：
+- `--base_model_path ./ckpts/FLUX.1-dev`
+- `--lora_path ./ckpts/HiFi-Inpaint`
+- `--demo_dir ./assets/inference_demo`
+- `--output_dir ./outputs`
+
+运行后会在 `outputs/` 下生成 `1_result.png` ~ `4_result.png`。
+
+示例：指定权重路径与输出目录
+
+```bash
+python infer.py \
+  --base_model_path ./ckpts/FLUX.1-dev \
+  --lora_path ./ckpts/HiFi-Inpaint \
+  --output_dir ./outputs
+```
+
+## 说明
+
+- `assets/inference_demo/` 内置 4 组 demo（`*_ref.jpg` 与 `*_masked.jpg`），`infer.py` 会自动遍历并生成结果。
+- 默认使用 bfloat16 并优先使用 CUDA；建议在具备 NVIDIA GPU 的环境运行。