preprocess_images

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

preprocess_images(config: Any, *, logger: Logger | None = None) → WorkflowResult[None] | None[source]

Run the batch image-preprocessing pipeline (habit preprocess recipe).

Parameters:

  • config – Validated preprocessing configuration (v0.1 schema object or mapping accepted by PreprocessingConfig).

  • logger – Optional run logger forwarded to the workflow helper.

Returns:

WorkflowResult with output directory metadata and a run manifest path.