{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "The runtime versions this heliaPROFILER records, and whether each is qualified for a precision on a board and clock.\n\nEvery name on this page is imported from `helia_profiler`.\n\n**API tier:** `experimental`\n\nGenerated from the `src/helia_profiler` tree `fe269596788d6ab1604cf433559e96b5f48c1d13`.",
      "name": "runtime_records",
      "path": "helia_profiler.runtime_records",
      "submodules": [],
      "summary": "The runtime versions this heliaPROFILER records, and whether each is qualified for a precision on a board and clock.",
      "symbols": [
        {
          "description": "What heliaPROFILER says about one runtime version, precision and target.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RuntimeQualification",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeQualification.QUALIFIED",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "QUALIFIED",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "QUALIFIED = 'qualified'",
              "source": {
                "line": 38,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L38"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeQualification.SUPPORTED",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "SUPPORTED",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "SUPPORTED = 'supported'",
              "source": {
                "line": 39,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L39"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeQualification.UNSUPPORTED",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "UNSUPPORTED",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "UNSUPPORTED = 'unsupported'",
              "source": {
                "line": 40,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L40"
              },
              "summary": ""
            }
          ],
          "name": "RuntimeQualification",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RuntimeQualification()",
          "source": {
            "line": 35,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L35"
          },
          "summary": "What heliaPROFILER says about one runtime version, precision and target."
        },
        {
          "description": "`dataclass`\n\nThe repository and commit a runtime version is built from.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RuntimeSource",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeSource.repo",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "repo",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "repo: str",
              "source": {
                "line": 47,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L47"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeSource.commit",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "commit",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "commit: str",
              "source": {
                "line": 48,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L48"
              },
              "summary": ""
            }
          ],
          "name": "RuntimeSource",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RuntimeSource(repo: str, commit: str) -> None",
          "source": {
            "line": 43,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L43"
          },
          "summary": "The repository and commit a runtime version is built from."
        },
        {
          "description": "`dataclass`\n\nA board class and clock the runtime is qualified on, and why.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.QualifiedTarget",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.QualifiedTarget.board",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "board",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "board: str",
              "source": {
                "line": 55,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L55"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.QualifiedTarget.clock",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "clock",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "clock: str",
              "source": {
                "line": 56,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L56"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.QualifiedTarget.precisions",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "precisions",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "precisions: tuple[str, ...]",
              "source": {
                "line": 57,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L57"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.QualifiedTarget.basis",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "basis",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "basis: str",
              "source": {
                "line": 58,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L58"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.QualifiedTarget.trace",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "trace",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "trace: str",
              "source": {
                "line": 59,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L59"
              },
              "summary": ""
            }
          ],
          "name": "QualifiedTarget",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "QualifiedTarget(board: str, clock: str, precisions: tuple[str, ...], basis: str, trace: str) -> None",
          "source": {
            "line": 51,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L51"
          },
          "summary": "A board class and clock the runtime is qualified on, and why."
        },
        {
          "description": "`dataclass`\n\nOne runtime version: its source, supported precisions and qualified targets.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RuntimeRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.name",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "name",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "name: str",
              "source": {
                "line": 66,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L66"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "version: str",
              "source": {
                "line": 67,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L67"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.default",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "default",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "default: bool",
              "source": {
                "line": 68,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L68"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "source: RuntimeSource",
              "source": {
                "line": 69,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L69"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.precisions",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "precisions",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "precisions: Mapping[str, str | None]",
              "source": {
                "line": 71,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L71"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.qualified",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "qualified",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "qualified: tuple[QualifiedTarget, ...]",
              "source": {
                "line": 72,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L72"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.kernels",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernels",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernels: RuntimeSource | None = None",
              "source": {
                "line": 74,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L74"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeRecord.archive_sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "archive_sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "archive_sha256: str | None = None",
              "source": {
                "line": 75,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L75"
              },
              "summary": ""
            }
          ],
          "name": "RuntimeRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RuntimeRecord(\n    name: str,\n    version: str,\n    default: bool,\n    source: RuntimeSource,\n    precisions: Mapping[str, str | None],\n    qualified: tuple[QualifiedTarget, ...],\n    kernels: RuntimeSource | None = None,\n    archive_sha256: str | None = None,\n) -> None",
          "source": {
            "line": 62,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L62"
          },
          "summary": "One runtime version: its source, supported precisions and qualified targets."
        },
        {
          "description": "`dataclass`\n\nThe answer for one runtime version, precision and target, with the record it came from.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.Qualification",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Qualification.state",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "state",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "state: RuntimeQualification",
              "source": {
                "line": 82,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L82"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Qualification.reason",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "reason",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "reason: str | None",
              "source": {
                "line": 83,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L83"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Qualification.record",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "record",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "record: RuntimeRecord | None",
              "source": {
                "line": 84,
                "path": "src/helia_profiler/runtime_records.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L84"
              },
              "summary": ""
            }
          ],
          "name": "Qualification",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Qualification(state: RuntimeQualification, reason: str | None, record: RuntimeRecord | None) -> None",
          "source": {
            "line": 78,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L78"
          },
          "summary": "The answer for one runtime version, precision and target, with the record it came from."
        },
        {
          "description": "`cached`\n\nEvery runtime record shipped with this heliaPROFILER, by name then version.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.runtimes",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "runtimes",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "runtimes() -> tuple[RuntimeRecord, ...]",
          "source": {
            "line": 87,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L87"
          },
          "summary": "Every runtime record shipped with this heliaPROFILER, by name then version."
        },
        {
          "description": "Whether ``name`` at ``version`` is qualified for ``precision`` on ``board`` at ``clock``.\n\n``board`` and ``clock`` must be a built-in board and one of its CPU clock\nprofiles (records qualify built-in boards only, so a ``target.custom_boards``\nname is refused too), and ``precision`` one of :data:`PRECISIONS`; anything\nelse raises ``ValueError``, the precision first.\n\nA version without a record, or a precision its record does not declare,\nis unsupported here, even when an engine's own version check would build\nit: this heliaPROFILER makes no claim about it.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.qualification",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "qualification",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "qualification(name: str, version: str | None = None, *, board: str, clock: str, precision: str) -> Qualification",
          "source": {
            "line": 133,
            "path": "src/helia_profiler/runtime_records.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/runtime_records.py#L133"
          },
          "summary": "Whether name at version is qualified for precision on board at clock."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}