onnxruntime 1.28.0: SessionOptions

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

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:7c11e5788b288583fec939144c48356e671919284a528ac4f4adf6566119e525","contract":["onnxruntime.SessionOptions configures intra_op_num_threads and inter_op_num_threads for thread pool sizing","onnxruntime.SessionOptions sets execution_mode and graph_optimization_level for runtime execution and graph optimization","onnxruntime.SessionOptions configures memory allocators and pattern optimization via enable_cpu_mem_arena and enable_mem_pattern","onnxruntime.SessionOptions configures log_severity_level and session log identifier","onnxruntime.SessionOptions stores and retrieves custom key-value entries via add_session_config_entry and raises RuntimeError on missing key"],"goal":"verify onnxruntime.SessionOptions in pkg:pypi/onnxruntime@1.28.0","kind":"HOW","packages":["pkg:pypi/onnxruntime@1.28.0"],"schemaVersion":1,"symbols":["onnxruntime.SessionOptions"]},"contractCommand":["python","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.SessionOptions"],"verifierAdapter":"python@1"}

onnxruntime==1.28.0

"""Demonstration of configuring onnxruntime.SessionOptions."""

from typing import Tuple
import onnxruntime as ort


def configure_thread_pool(
    options: ort.SessionOptions,
    intra_threads: int,
    inter_threads: int,
) -> ort.SessionOptions:
    """Configure thread counts for intra-op and inter-op parallelism."""
    options.intra_op_num_threads = intra_threads
    options.inter_op_num_threads = inter_threads
    return options


def configure_execution_and_optimization(
    options: ort.SessionOptions,
    execution_mode: ort.ExecutionMode,
    opt_level: ort.GraphOptimizationLevel,
) -> ort.SessionOptions:
    """Set execution mode and graph optimization level."""
    options.execution_mode = execution_mode
    options.graph_optimization_level = opt_level
    return options


def configure_memory_management(
    options: ort.SessionOptions,
    enable_arena: bool,
    enable_pattern: bool,
) -> ort.SessionOptions:
    """Configure CPU memory arena allocator and memory pattern optimization."""
    options.enable_cpu_mem_arena = enable_arena
    options.enable_mem_pattern = enable_pattern
    return options


def configure_logging(
    options: ort.SessionOptions,
    severity_level: int,
    log_id: str,
) -> ort.SessionOptions:
    """Set logging severity level and session log identifier."""
    options.log_severity_level = severity_level
    options.logid = log_id
    return options


def add_and_get_session_config(
    options: ort.SessionOptions,
    key: str,
    value: str,
) -> str:
    """Add a custom session configuration entry and retrieve its value."""
    options.add_session_config_entry(key, value)
    return options.get_session_config_entry(key)

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

"""Contract verification tests for onnxruntime.SessionOptions."""

import os
import sys

# Ensure project root is on sys.path for local module imports
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

import onnxruntime as ort
from sample import (
    configure_thread_pool,
    configure_execution_and_optimization,
    configure_memory_management,
    configure_logging,
    add_and_get_session_config,
)


def test_thread_pool_configuration() -> None:
    """Assertion 1: onnxruntime.SessionOptions configures intra_op_num_threads and inter_op_num_threads for thread pool sizing."""
    options = ort.SessionOptions()
    assert options.intra_op_num_threads == 0
    assert options.inter_op_num_threads == 0

    configure_thread_pool(options, intra_threads=4, inter_threads=2)
    assert options.intra_op_num_threads == 4
    assert options.inter_op_num_threads == 2


def test_execution_mode_and_optimization() -> None:
    """Assertion 2: onnxruntime.SessionOptions sets execution_mode and graph_optimization_level for runtime execution and graph optimization."""
    options = ort.SessionOptions()
    assert options.execution_mode == ort.ExecutionMode.ORT_SEQUENTIAL
    assert options.graph_optimization_level == ort.GraphOptimizationLevel.ORT_ENABLE_ALL

    configure_execution_and_optimization(
        options,
        execution_mode=ort.ExecutionMode.ORT_PARALLEL,
        opt_level=ort.GraphOptimizationLevel.ORT_ENABLE_BASIC,
    )
    assert options.execution_mode == ort.ExecutionMode.ORT_PARALLEL
    assert options.graph_optimization_level == ort.GraphOptimizationLevel.ORT_ENABLE_BASIC


def test_memory_management_configuration() -> None:
    """Assertion 3: onnxruntime.SessionOptions configures memory allocators and pattern optimization via enable_cpu_mem_arena and enable_mem_pattern."""
    options = ort.SessionOptions()
    assert options.enable_cpu_mem_arena is True
    assert options.enable_mem_pattern is True

    configure_memory_management(options, enable_arena=False, enable_pattern=False)
    assert options.enable_cpu_mem_arena is False
    assert options.enable_mem_pattern is False


def test_logging_configuration() -> None:
    """Assertion 4: onnxruntime.SessionOptions configures log_severity_level and session log identifier."""
    options = ort.SessionOptions()
    configure_logging(options, severity_level=2, log_id="SessionOptTest")
    assert options.log_severity_level == 2
    assert options.logid == "SessionOptTest"


def test_session_config_entries() -> None:
    """Assertion 5: onnxruntime.SessionOptions stores and retrieves custom key-value entries via add_session_config_entry and raises RuntimeError on missing key."""
    options = ort.SessionOptions()
    key = "session.use_env_allocators"
    val = "1"
    retrieved = add_and_get_session_config(options, key, val)
    assert retrieved == val
    assert options.get_session_config_entry(key) == val

    raised = False
    try:
        options.get_session_config_entry("nonexistent.config.entry")
    except RuntimeError:
        raised = True
    assert raised, "Expected RuntimeError when querying nonexistent session config entry"


def main() -> None:
    test_thread_pool_configuration()
    test_execution_mode_and_optimization()
    test_memory_management_configuration()
    test_logging_configuration()
    test_session_config_entries()
    print("All contract assertions passed.")


if __name__ == "__main__":
    main()