save_habitat_config

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.

save_habitat_config(path: str | Path, spec: HabitatSpec, *, data_source: str | Path, out_dir: str | Path, policy: RunPolicy | None = None, mode: str = 'train', pipeline: str | Path | None = None, save_images: bool = True, save_results_csv: bool = True, habitats_results_format: str = 'parquet', plot_curves: bool = True) → Path[source]

Write a complete effective v1 habitat YAML for CLI / YAML-API replay.

Parameters:

  • path – Destination YAML path.

  • spec – Analysis declaration.

  • data_source – Cohort root or manifest path recorded under data.source.

  • out_dir – Output directory recorded under output.out_dir.

  • policy – Optional run policy (defaults expanded when omitted).

  • mode – "train" or "predict".

  • pipeline – Predict-mode model archive path.

  • save_images – See build_habitat_document().

  • save_results_csv – See build_habitat_document().

  • habitats_results_format – See build_habitat_document().

  • plot_curves – See build_habitat_document().

Returns:

The written path.