coco_pipe.report.config¶
Pydantic models for validating report configuration and metadata.
Classes¶
- ProvenanceConfig
Capture environment and execution metadata.
- ReportConfig
Main configuration for the report generation.
Author: Hamza Abdelhedi (hamza.abdelhedi@umontreal.ca)
Classes¶
Configuration for execution provenance. |
|
Configuration for the Report object. |
Module Contents¶
- class coco_pipe.report.config.ProvenanceConfig(/, **data: Any)[source]¶
Bases:
pydantic.BaseModelConfiguration for execution provenance.
- model_config¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- source: str = None¶
- git_hash: str = None¶
- timestamp_utc: str = None¶
- command: str | None = None¶
- python_version: str | None = None¶
- os_platform: str | None = None¶
- versions: Dict[str, str] = None¶
- class coco_pipe.report.config.ReportConfig(/, **data: Any)[source]¶
Bases:
pydantic.BaseModelConfiguration for the Report object.
- model_config¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- title: str = None¶
- author: str | None = None¶
- description: str | None = None¶
- provenance: ProvenanceConfig | None = None¶
- run_params: Dict[str, Any] = None¶