petitRADTRANS.sbi.artifacts#

Artifact metadata and registry interfaces for SBI assets.

Classes#

ArtifactRole

Artifact categories produced by the SBI workflow.

ArtifactMetadata

Traceability metadata shared by all persisted SBI artifacts.

ArtifactRegistry

Resolve and persist versioned SBI artifacts.

RegisteredArtifact

Stored registry entry for one persisted artifact.

FileArtifactRegistry

Simple JSON-backed registry for local SBI artifacts.

Module Contents#

class petitRADTRANS.sbi.artifacts.ArtifactRole#

Bases: str, enum.Enum

Artifact categories produced by the SBI workflow.

SIMULATION_DATASET = 'simulation_dataset'#
POSTERIOR_MODEL = 'posterior_model'#
BENCHMARK_REPORT = 'benchmark_report'#
CALIBRATION_REPORT = 'calibration_report'#
class petitRADTRANS.sbi.artifacts.ArtifactMetadata#

Traceability metadata shared by all persisted SBI artifacts.

role: ArtifactRole#
task_name: str#
version: str#
estimator_family: str | None = None#
task_version: str | None = None#
task_fingerprint: str | None = None#
preprocessing_version: str | None = None#
forward_model_family: str | None = None#
petitradtrans_version: str | None = None#
retrieval_config_digest: str | None = None#
opacity_digest: str | None = None#
observation_schema: Mapping[str, Any]#
preprocessing_metadata: Mapping[str, Any]#
metadata: Mapping[str, Any]#
to_payload() dict[str, Any]#
classmethod from_payload(payload: Mapping[str, Any]) ArtifactMetadata#
classmethod from_task(task: petitRADTRANS.sbi.task.SBITask, role: ArtifactRole, version: str, estimator_family: str | None = None, metadata: Mapping[str, Any] | None = None, preprocessing_metadata: Mapping[str, Any] | None = None, retrieval_config_digest: str | None = None, opacity_digest: str | None = None) ArtifactMetadata#

Build artifact metadata from an SBI task family.

class petitRADTRANS.sbi.artifacts.ArtifactRegistry#

Bases: abc.ABC

Resolve and persist versioned SBI artifacts.

abstractmethod register(metadata: ArtifactMetadata, location: str) None#

Register an artifact location under the supplied metadata.

abstractmethod resolve(role: ArtifactRole, task_name: str, version: str | None = None) str#

Resolve an artifact path or URI for the requested task and role.

class petitRADTRANS.sbi.artifacts.RegisteredArtifact#

Stored registry entry for one persisted artifact.

metadata: ArtifactMetadata#
location: str#
to_payload() dict[str, Any]#
classmethod from_payload(payload: Mapping[str, Any]) RegisteredArtifact#
class petitRADTRANS.sbi.artifacts.FileArtifactRegistry(root_directory: str)#

Bases: ArtifactRegistry

Simple JSON-backed registry for local SBI artifacts.

root_directory#
index_path#
_load_entries() list[RegisteredArtifact]#
_write_entries(entries: list[RegisteredArtifact]) None#
register(metadata: ArtifactMetadata, location: str) None#

Register an artifact location under the supplied metadata.

resolve(role: ArtifactRole, task_name: str, version: str | None = None) str#

Resolve an artifact path or URI for the requested task and role.