satellit_sam.workflows.run_metadata

Auto-generated from satellit_sam/src/satellit_sam/workflows/run_metadata.py by satellit_sam/scripts/generate_api_docs.py.

Helpers for writing workflow run metadata artifacts.

Back to API index

Functions

write_run_metadata

def write_run_metadata(
    output_dir: Path,
    *,
    image_path: Path,
    tile_size: int,
    tile_overlap: int,
    prompt: dict[str, Any] | None,
    model: str | None,
    command: str | None,
) -> Path:
Write one workflow metadata artifact at ``/metadata.json``.

Arguments

  • output_dir: Root output directory for the workflow run. image_path: Source image path used for the run. tile_size: Configured tile size in pixels. tile_overlap: Configured tile overlap in pixels. prompt: Prompt payload used by the workflow, if applicable. model: Model identifier used by the workflow, if applicable. command: CLI command used to start the run, if available.

Returns

  • Path to the written ``metadata.json`` file.

Classes

No public classes.

Previoussatellit_sam.workflows.process.tiling