manifest

The on-disk index of a run directory: the artifacts it holds, the issues raised against it, and whether its numbers may be used.

Every name on this page is imported from helia_profiler.

API tier: experimental

Generated from the src/helia_profiler tree fe269596788d6ab1604cf433559e96b5f48c1d13.

Machine-readable model

RunStatusclassPublication status of a result bundle.
ResultValidityclassWhether measurements in a completed bundle are authoritative.
ResultIssueclassOne stable machine-readable issue with optional open context.
ResultArtifactclassOne content-addressed file in a result bundle.
ResultManifestclassStable result envelope with open provenance and extension payloads.
load_result_manifestfunctionLoad a result manifest and optionally verify its sibling artifacts.

RunStatus()

Publication status of a result bundle.

API tier: experimental

COMPLETE = 'complete'

INCOMPLETE = 'incomplete'

FAILED = 'failed'

ResultValidity()

Whether measurements in a completed bundle are authoritative.

API tier: experimental

VALID = 'valid'

DEGRADED = 'degraded'

INVALID = 'invalid'

ResultIssue(
    code: str,
    severity: str,
    message: str,
    context: dict[str, Any] = dict(),
    extra: dict[str, Any] = dict(),
) -> None

dataclass

One stable machine-readable issue with optional open context.

API tier: experimental

code: str

severity: str

message: str

context: dict[str, Any] = field(default_factory=dict)

extra: dict[str, Any] = field(default_factory=dict, repr=False)

from_dict(data: dict[str, Any]) -> Self

classmethod

to_dict() -> dict[str, Any]

ResultArtifact(
    path: str,
    media_type: str,
    size_bytes: int,
    sha256: str,
    role: str | None = None,
    name: str | None = None,
    schema: str | None = None,
    schema_version: int | None = None,
    producer: str | None = None,
    optional: bool | None = None,
    extra: dict[str, Any] = dict(),
) -> None

dataclass

One content-addressed file in a result bundle.

API tier: experimental

path: str

media_type: str

size_bytes: int

sha256: str

role: str | None = None

name: str | None = None

schema: str | None = None

schema_version: int | None = None

producer: str | None = None

optional: bool | None = None

extra: dict[str, Any] = field(default_factory=dict, repr=False)

from_dict(data: dict[str, Any]) -> Self

classmethod

to_dict() -> dict[str, Any]

ResultManifest(
    schema: str,
    schema_version: int,
    run_id: str,
    timestamp: str,
    hpx_version: str,
    status: RunStatus,
    validity: ResultValidity,
    issues: tuple[ResultIssue, ...],
    provenance: dict[str, Any],
    comparability: dict[str, Any],
    artifacts: tuple[ResultArtifact, ...],
    bundle_type: str | None = None,
    extensions: dict[str, Any] = dict(),
    extra: dict[str, Any] = dict(),
) -> None

dataclass

Stable result envelope with open provenance and extension payloads.

API tier: experimental

schema: str

schema_version: int

run_id: str

timestamp: str

hpx_version: str

status: RunStatus

validity: ResultValidity

issues: tuple[ResultIssue, ...]

provenance: dict[str, Any]

comparability: dict[str, Any]

artifacts: tuple[ResultArtifact, ...]

bundle_type: str | None = None

extensions: dict[str, Any] = field(default_factory=dict)

extra: dict[str, Any] = field(default_factory=dict, repr=False)

from_dict(data: dict[str, Any]) -> Self

classmethod

load(path: str | Path) -> Self

classmethod

Load a manifest while preserving unknown fields.

to_dict() -> dict[str, Any]

write(path: str | Path) -> Path

Write the manifest without discarding unknown fields.

verify(bundle_dir: str | Path) -> None

Verify all declared artifact paths, sizes, and SHA-256 digests.

load_result_manifest(path: str | Path, *, verify: bool = False) -> ResultManifest

Load a result manifest and optionally verify its sibling artifacts.

API tier: experimental

Machine-readable: manifest.json · manifest.md, complete and lossless.