onnxruntime 1.28.0: ModelMetadata

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify onnxruntime.ModelMetadata in pkg:pypi/onnxruntime@1.28.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:pypi/onnxruntime@1.28.0
Demonstrate these symbols/APIs:
  - onnxruntime.ModelMetadata

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:18b0806ba149517d6245df3f5e58ed2dcca724e1abcff4f8b0a07d8753872fc5","contract":["assert InferenceSession.get_modelmeta returns ModelMetadata instance representing ONNX model metadata","assert ModelMetadata exposes standard properties producer_name, domain, description, graph_name, graph_description, and version","assert ModelMetadata.custom_metadata_map returns a dictionary mapping custom string keys to string values","assert ModelMetadata loaded from serialized byte buffer matches metadata loaded from disk file path","assert ModelMetadata provides empty string and empty dict defaults for models without optional metadata","assert ModelMetadata class rejects direct instantiation with TypeError as it is constructed via session"],"goal":"verify onnxruntime.ModelMetadata in pkg:pypi/onnxruntime@1.28.0","kind":"HOW","packages":["pkg:pypi/onnxruntime@1.28.0"],"schemaVersion":1,"symbols":["onnxruntime.ModelMetadata"]},"contractCommand":["python3","test/contract.py"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"pypi","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"pip","schemaVersion":1},"license":"MIT-0","packages":["pkg:pypi/onnxruntime@1.28.0"],"schemaVersion":1,"subject":"pkg:pypi/onnxruntime@1.28.0","symbols":["onnxruntime.ModelMetadata"],"verifierAdapter":"python@1"}

[project]
name = "verify-onnxruntime-modelmetadata"
version = "0.1.0"
dependencies = [
    "onnxruntime==1.28.0",
]

onnxruntime==1.28.0

{
  "schemaVersion": 1,
  "goal": "verify onnxruntime.ModelMetadata in pkg:pypi/onnxruntime@1.28.0",
  "kind": "HOW",
  "packages": [
    "pkg:pypi/onnxruntime@1.28.0"
  ],
  "symbols": [
    "onnxruntime.ModelMetadata"
  ]
}

import os
import tempfile
import onnxruntime as ort

MODEL_WITH_METADATA = bytes.fromhex(
    "080d120f73616d706c655f70726f64756365721a03312e30220f6465762e636f646573616d706c6578282a322253616d706c65206d6f64656c2074657374696e67204d6f64656c4d657461646174613a600a100a015812015922084964656e7469747912156d657461646174615f73616d706c655f67726170685a0f0a0158120a0a08080112040a020801620f0a0159120a0a08080112040a020801521347726170682077697468206d657461646174614202100e721c0a0d73616d706c655f617574686f72120b436f646553616d706c655872190a0b656e7669726f6e6d656e74120a70726f64756374696f6e"
)

MODEL_MINIMAL = bytes.fromhex(
    "080d3a410a100a015812015922084964656e74697479120b656d7074795f67726170685a0f0a0158120a0a08080112040a020801620f0a0159120a0a08080112040a0208014202100e"
)


def test_model_metadata_attributes():
    session = ort.InferenceSession(MODEL_WITH_METADATA)
    meta = session.get_modelmeta()

    assert isinstance(meta, ort.ModelMetadata)
    assert meta.producer_name == "sample_producer"
    assert meta.domain == "dev.codesamplex"
    assert meta.description == "Sample model testing ModelMetadata"
    assert meta.graph_name == "metadata_sample_graph"
    assert meta.graph_description == "Graph with metadata"
    assert meta.version == 42


def test_custom_metadata_map():
    session = ort.InferenceSession(MODEL_WITH_METADATA)
    meta = session.get_modelmeta()

    custom_map = meta.custom_metadata_map
    assert isinstance(custom_map, dict)
    assert "sample_author" in custom_map
    assert custom_map["sample_author"] == "CodeSampleX"
    assert custom_map.get("environment") == "production"
    assert custom_map.get("nonexistent") is None
    assert len(custom_map) == 2


def test_model_metadata_from_file():
    with tempfile.NamedTemporaryFile("wb", suffix=".onnx", delete=False) as f:
        f.write(MODEL_WITH_METADATA)
        temp_path = f.name

    try:
        session = ort.InferenceSession(temp_path)
        meta = session.get_modelmeta()

        assert meta.producer_name == "sample_producer"
        assert meta.domain == "dev.codesamplex"
        assert meta.description == "Sample model testing ModelMetadata"
        assert meta.graph_name == "metadata_sample_graph"
        assert meta.graph_description == "Graph with metadata"
        assert meta.version == 42
        assert meta.custom_metadata_map == {
            "sample_author": "CodeSampleX",
            "environment": "production",
        }
    finally:
        if os.path.exists(temp_path):
            os.unlink(temp_path)


def test_model_metadata_defaults():
    session = ort.InferenceSession(MODEL_MINIMAL)
    meta = session.get_modelmeta()

    assert meta.producer_name == ""
    assert meta.domain == ""
    assert meta.description == ""
    assert meta.graph_name == "empty_graph"
    assert meta.graph_description == ""
    assert meta.custom_metadata_map == {}


def test_model_metadata_instantiation():
    try:
        ort.ModelMetadata()
        assert False, "ModelMetadata should not allow direct instantiation"
    except TypeError as exc:
        assert "No constructor defined" in str(exc) or isinstance(exc, TypeError)


def main():
    test_model_metadata_attributes()
    test_custom_metadata_map()
    test_model_metadata_from_file()
    test_model_metadata_defaults()
    test_model_metadata_instantiation()
    print("All onnxruntime.ModelMetadata contract assertions passed.")


if __name__ == "__main__":
    main()