LegacyCheckpointMigrationReport

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class LegacyCheckpointMigrationReport(migrated: bool = False, completed_migrated: ~typing.List[str] = <factory>, completed_payload_skipped: ~typing.List[str] = <factory>, failed_migrated: ~typing.List[str] = <factory>, archive_dir: str | None = None, notes: ~typing.List[str] = <factory>)

Bases: object

Outcome of one v0.1 → v1 checkpoint migration attempt.

migrated

Whether a v0.1 layout was detected and processed.

Type:

bool

completed_migrated

Subject IDs whose scientific payload was written as a v1 success entry.

Type:

List[str]

completed_payload_skipped

Subject IDs listed as completed in the v0.1 manifest but whose payload could not be scientifically reused (will recompute on resume).

Type:

List[str]

failed_migrated

Subject IDs written as v1 failure records.

Type:

List[str]

archive_dir

Directory holding the archived v0.1 tree, or None.

Type:

str | None

notes

Human-readable log lines describing conversion limits.

Type:

List[str]

to_dict() → Dict[str, Any]

Return a JSON-serialisable summary.

__init__(migrated: bool = False, completed_migrated: ~typing.List[str] = <factory>, completed_payload_skipped: ~typing.List[str] = <factory>, failed_migrated: ~typing.List[str] = <factory>, archive_dir: str | None = None, notes: ~typing.List[str] = <factory>) → None