raiiaf.chunks.env

Environment chunk utilities for RAIIAF.

Defines dataclasses for environment components and provides helpers to populate, build (compress), and parse environment (ENVC) chunks.

Classes

EnvChunk(env_version, components)

Structured environment chunk content.

EnvComponent(component_id, cononical_str, ...)

Single environment component captured in the ENVC chunk.

raiiafEnv()

Operations for RAIIAF environment (ENVC) chunks.

class raiiaf.chunks.env.EnvChunk(env_version: int, components: List[EnvComponent])[source]

Bases: object

Structured environment chunk content.

env_version

Environment chunk version number.

Type:

int

components

List of environment components.

Type:

List[EnvComponent]

components: List[EnvComponent]
env_version: int
class raiiaf.chunks.env.EnvComponent(component_id: str, cononical_str: str, component_sha256_digest: bytes)[source]

Bases: object

Single environment component captured in the ENVC chunk.

component_id

Identifier (e.g., ‘torch’, ‘numpy’, ‘python’, ‘cuda’, ‘os’, ‘gpu’).

Type:

str

cononical_str

Canonical string describing the component and version.

Type:

str

component_sha256_digest

SHA-256 digest for the canonical string.

Type:

bytes

component_id: str
component_sha256_digest: bytes
cononical_str: str
class raiiaf.chunks.env.raiiafEnv[source]

Bases: object

Operations for RAIIAF environment (ENVC) chunks.

env_chunk_builder(env_chunk: EnvChunk)[source]

Build a compressed ENVC chunk from an EnvChunk object.

Parameters:

env_chunk (EnvChunk) – Populated environment chunk object.

Returns:

Compressed chunk bytes and the raw env JSON bytes.

Return type:

Tuple[bytes, bytes]

Raises:

raiiafEnvChunkError – If building or compression fails.

env_chunk_parser(compressed_chunk)[source]

Parse a compressed ENVC chunk.

Parameters:

compressed_chunk (bytes) – Compressed environment chunk.

Returns:

Parsed environment with keys ‘chunk_type’, ‘chunk_flags’, ‘chunk_size’, ‘env_chunk’.

Return type:

dict

env_chunk_populator()[source]

Populate the environment chunk with component hashes.

Returns:

Populated environment chunk object with common components.

Return type:

EnvChunk