raiiaf.chunks.metadata

Metadata chunk utilities for RAIIAF.

Provides validation against a JSON schema, compression/decompression helpers for the metadata chunk (META), and manifest construction helpers.

Classes

raiiafMetadata()

Operations for RAIIAF metadata (META) chunks.
class raiiaf.chunks.metadata.raiiafMetadata[source]

Bases: object

Operations for RAIIAF metadata (META) chunks.

build_manifest(version_major: int, version_minor: int, model_name: str, model_version: str, prompt: str, tags: list, chunk_records: list, generation_settings: dict | None = None, hardware_info: dict | None = None)[source]

Build a manifest dictionary from inputs and chunk records.

chunk_records must be a list of dicts, with each having:

{
    "type": str,
    "flags": str,
    "offset": int,
    "compressed_size": int,
    "uncompressed_size": int,
    "hash": str,
    "extra": dict
}
Parameters:

  • version_major (int) – Major version number.

  • version_minor (int) – Minor version number.

  • model_name (str) – Name of the model.

  • model_version (str) – Version of the model.

  • prompt (str) – Prompt used for generation.

  • tags (list) – List of tags.

  • chunk_records (list) – List of chunk record dictionaries.

  • generation_settings (Optional[dict]) – Generation settings. Defaults to predefined structure if not provided.

  • hardware_info (Optional[dict]) – Hardware information. Defaults to predefined structure if not provided.

Returns:

Manifest dictionary.

Return type:

dict

metadata_compressor(manifest)[source]

Compress a manifest into a META chunk.

Parameters:

manifest (dict) – Manifest dictionary to serialize and compress.

Returns:

Compressed META chunk bytes.

Return type:

bytes

metadata_parser(compressed_chunk: bytes) → dict[source]

Parse and decompress a META chunk.

Parameters:

compressed_chunk (bytes) – Compressed metadata chunk.

Returns:

Parsed metadata manifest.

Return type:

dict

metadata_validator(manifest) → bool[source]

Validate a metadata manifest using the JSON Schema.

Parameters:

manifest (dict) – Metadata manifest.

Returns:

True if it is valid.

Return type:

bool

Raises:

raiiafMetadataError – If the metadata is invalid.