feat(api): add detailer postprocess script and /sdapi/v1/detail endpoint

Surface YoloRestorer.restore() as a standalone operation: a Detailer
postprocessing script in the Process tab and a thin /sdapi/v1/detail
endpoint, neither requiring a base generation pass.

- modules/postprocess/yolo.py: YoloRestorer.make_processing() builds the
  synthetic Img2Img processing object both entry points feed to restore(),
  resolving the seed so the inpaint passes are reproducible
- modules/api/process.py: post_detail handler exposes the full detailer
  parameter set and returns the detailed image plus optional annotations
  as base64
- scripts/postprocessing_detailer.py: reuses shared.yolo.ui('extras') and
  runs through make_processing()
- modules/postprocessing.py: run_extras takes a per-script script_args
  dict, also letting the extras API drive other scripts such as Remove
  background; omitting it leaves existing callers unchanged
- modules/api/models.py: ReqDetail / ResDetail
- modules/processing_info.py: guard create_infotext's Image/Hires CFG
  reporting against an unset (None) cfg_image, matching the is-not-None
  checks the other cfg_image readers use; the detailer inpaint pass runs
  with it unset
- test/test-detailer-api.py: covers both paths; effect tests measure the
  diff inside the detected region with extreme isolated parameter values,
  and the suite disables model quantization for the run and restores the
  original settings afterward
This commit is contained in:
CalamitousFelicitousness
2026-05-07 22:47:43 +01:00
parent c3eec8e60b
commit f9ab0bf04d
9 changed files with 715 additions and 56 deletions
+39
View File
@@ -343,6 +343,7 @@ class ReqProcess(BaseModel):
upscaler_1: str = Field(default="None", title="Main upscaler", description=f"The name of the main upscaler to use, it has to be one of this list: {' , '.join([x.name for x in shared.sd_upscalers])}")
upscaler_2: str = Field(default="None", title="Refine upscaler", description=f"The name of the secondary upscaler to use, it has to be one of this list: {' , '.join([x.name for x in shared.sd_upscalers])}")
extras_upscaler_2_visibility: float = Field(default=0, title="Refine upscaler visibility", ge=0, le=1, allow_inf_nan=False, description="Sets the visibility of secondary upscaler, values should be between 0 and 1.")
script_args: dict | None = Field(default=None, title="Script args", description="Per-script arguments keyed by script name, e.g. {\"Detailer\": {\"strength\": 0.5}, \"Remove background\": {\"model\": \"u2net\"}}.")
class ResProcess(BaseModel):
html_info: str = Field(title="HTML info", description="A series of HTML tags containing the process info.")
@@ -391,6 +392,44 @@ class ReqProcessBatch(ReqProcess):
class ResProcessBatch(ResProcess):
images: list[str] = Field(title="Images", description="The generated images in base64 format.")
class ReqDetail(BaseModel):
image: str = Field(title="Image", description="Base64-encoded input image to detail")
seed: int | None = Field(default=-1, title="Seed", description="Seed for inpainting passes (-1 = random)")
detailer_models: list[str] | None = Field(default=None, title="Detailer models", description="List of YOLO detailer model names to run; falls back to shared.opts.detailer_models when omitted")
detailer_prompt: str | None = Field(default=None, title="Detailer prompt", description="Override prompt for detailer pass; supports [PROMPT]/[prompt] splice tokens")
detailer_negative: str | None = Field(default=None, title="Detailer negative", description="Override negative prompt for detailer pass")
detailer_steps: int | None = Field(default=None, ge=0, le=99, title="Detailer steps")
detailer_strength: float | None = Field(default=None, ge=0.0, le=1.0, title="Detailer strength")
detailer_resolution: int | None = Field(default=None, ge=256, le=4096, title="Detailer resolution")
detailer_sampler: str | None = Field(default=None, title="Detailer sampler", description="Sampler name for the inpaint pass; a named sampler activates the scheduler overrides below, 'Default' keeps the model scheduler")
detailer_prediction: str | None = Field(default=None, title="Detailer prediction", description="Scheduler prediction type override (default/epsilon/sample/v_prediction/flow_prediction)")
detailer_shift: float | None = Field(default=None, ge=0.0, le=10.0, title="Detailer flow shift", description="Flow/sampler shift for the inpaint pass; needs a named sampler")
detailer_cfg_scale: float | None = Field(default=None, ge=0.0, le=30.0, title="Detailer guidance scale", description="CFG/guidance scale for the inpaint pass")
detailer_loworder: bool | None = Field(default=None, title="Detailer low order")
detailer_thresholding: bool | None = Field(default=None, title="Detailer thresholding")
detailer_dynamic: bool | None = Field(default=None, title="Detailer dynamic shift")
detailer_rescale: bool | None = Field(default=None, title="Detailer rescale betas")
detailer_classes: str | None = Field(default=None, title="Detailer classes", description="Comma-separated class allowlist (e.g. 'face,eye')")
detailer_conf: float | None = Field(default=None, ge=0.0, le=1.0, title="Min confidence")
detailer_iou: float | None = Field(default=None, ge=0.0, le=1.0, title="Max overlap (IoU)")
detailer_max: int | None = Field(default=None, ge=1, title="Max detections")
detailer_min_size: float | None = Field(default=None, ge=0.0, le=1.0, title="Min relative size")
detailer_max_size: float | None = Field(default=None, ge=0.0, le=1.0, title="Max relative size")
detailer_blur: int | None = Field(default=None, ge=0, le=100, title="Mask blur")
detailer_padding: int | None = Field(default=None, ge=0, le=100, title="Mask padding")
detailer_segmentation: bool | None = Field(default=None, title="Use segmentation", description="Use seg-mask instead of bbox (requires a -seg model)")
detailer_merge: bool | None = Field(default=None, title="Merge detections")
detailer_sort: bool | None = Field(default=None, title="Sort detections", description="Sort detections left-to-right for consistency")
detailer_sigma_adjust: float | None = Field(default=None, ge=0.5, le=1.5, title="Renoise sigma")
detailer_sigma_adjust_max: float | None = Field(default=None, ge=0.0, le=1.0, title="Renoise end")
detailer_include_detections: bool | None = Field(default=None, title="Include detections", description="Return annotated debug image alongside the detailed result")
class ResDetail(BaseModel):
image: str = Field(title="Image", description="Detailed image (base64)")
detections: str | None = Field(default=None, title="Detections", description="Annotated debug image (base64) when detailer_include_detections=True")
seed: int = Field(default=-1, title="Seed", description="Effective seed used for the detailer pass")
info: str = Field(default='', title="Info", description="Postprocessing info string")
class ReqImageInfo(BaseModel):
image: str = Field(title="Image", description="The base64 encoded image")