onnxruntime 1.28.0: RunOptions

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.RunOptions 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.RunOptions

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:52c80a437345a88f66d31f88f1cfe8e5180c6af6215606f283d488b8b11a2476","contract":["assert RunOptions initializes with default log_severity_level, log_verbosity_level, empty logid, terminate False, and only_execute_path_to_fetches False","assert RunOptions properties log_severity_level, log_verbosity_level, logid, and only_execute_path_to_fetches can be mutated","assert RunOptions.add_run_config_entry stores custom key-value configuration and get_run_config_entry retrieves it","assert RunOptions.get_run_config_entry raises RuntimeError when queried with a non-existent key","assert InferenceSession.run executes inference with custom RunOptions on an ONNX model graph","assert InferenceSession.run aborts with RuntimeError or Fail exception when RunOptions.terminate is set to True"],"goal":"verify onnxruntime.RunOptions in pkg:pypi/onnxruntime@1.28.0","kind":"HOW","packages":["pkg:pypi/onnxruntime@1.28.0"],"schemaVersion":1,"symbols":["onnxruntime.RunOptions"]},"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.RunOptions"],"verifierAdapter":"python@1"}

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

onnxruntime==1.28.0
numpy

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

import numpy as np
import onnxruntime as ort

MODEL_BYTES = (
    b"\x08\r\x12\x08csx_test:H\n\x10\n\x01X\x12\x01Y\"\x08Identity\x12\ntest_modelZ"
    b"\x13\n\x01X\x12\x0e\n\x0c\x08\x01\x12\x08\n\x02\x08\x01\n\x02\x08\x02b"
    b"\x13\n\x01Y\x12\x0e\n\x0c\x08\x01\x12\x08\n\x02\x08\x01\n\x02\x08\x02B\x04\n\x00\x10\x11"
)


def test_run_options_instantiation_and_defaults():
    ro = ort.RunOptions()
    assert ro.log_severity_level == -1
    assert ro.log_verbosity_level == 0
    assert ro.logid == ""
    assert ro.terminate is False
    assert ro.only_execute_path_to_fetches is False


def test_run_options_property_mutations():
    ro = ort.RunOptions()
    ro.log_severity_level = 2
    assert ro.log_severity_level == 2

    ro.log_verbosity_level = 1
    assert ro.log_verbosity_level == 1

    ro.logid = "custom_run_tag"
    assert ro.logid == "custom_run_tag"

    ro.only_execute_path_to_fetches = True
    assert ro.only_execute_path_to_fetches is True


def test_run_options_run_config_entries():
    ro = ort.RunOptions()
    ro.add_run_config_entry("disable_synchronize_execution_providers", "1")
    assert ro.get_run_config_entry("disable_synchronize_execution_providers") == "1"

    try:
        ro.get_run_config_entry("non_existent_entry_key")
        assert False, "Should have raised RuntimeError"
    except RuntimeError as exc:
        assert "does not have configuration with key" in str(exc)


def test_inference_session_run_with_run_options():
    session = ort.InferenceSession(MODEL_BYTES, providers=["CPUExecutionProvider"])
    ro = ort.RunOptions()
    ro.logid = "session_eval"
    input_tensor = np.array([[3.14, 2.71]], dtype=np.float32)
    outputs = session.run(["Y"], {"X": input_tensor}, run_options=ro)
    assert np.allclose(outputs[0], input_tensor)


def test_inference_session_run_terminate_flag():
    session = ort.InferenceSession(MODEL_BYTES, providers=["CPUExecutionProvider"])
    ro_term = ort.RunOptions()
    ro_term.terminate = True
    input_tensor = np.array([[3.14, 2.71]], dtype=np.float32)
    try:
        session.run(["Y"], {"X": input_tensor}, run_options=ro_term)
        assert False, "Should have aborted due to terminate flag"
    except Exception as exc:
        assert "terminate" in str(exc).lower()


def main():
    test_run_options_instantiation_and_defaults()
    test_run_options_property_mutations()
    test_run_options_run_config_entries()
    test_inference_session_run_with_run_options()
    test_inference_session_run_terminate_flag()
    print("All onnxruntime.RunOptions contract assertions passed.")


if __name__ == "__main__":
    main()