{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "Shared identity vocabulary: the identity of a captured run and the build, run, energy, runtime and kernel facts it names, canonical engine and kernel names with today's spellings as aliases, unknown facts that carry their reason, and the semantic hashes that name their kind and basis version.\n\nEvery name on this page is imported from `helia_profiler`.\n\n**API tier:** `experimental`\n\nGenerated from the `src/helia_profiler` tree `f38e378c801d34438affb680257217e0b58d2cd1`.",
      "name": "identity",
      "path": "helia_profiler.identity",
      "submodules": [],
      "summary": "Shared identity vocabulary: the identity of a captured run and the build, run, energy, runtime and kernel facts it names, canonical engine and kernel names wit…",
      "symbols": [
        {
          "description": "An inference engine, by its shared name.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.CanonicalEngine",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalEngine.LITERT",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "LITERT",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "LITERT = 'litert'",
              "source": {
                "line": 27,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L27"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalEngine.HELIA_RT",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "HELIA_RT",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "HELIA_RT = 'helia-rt'",
              "source": {
                "line": 28,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L28"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalEngine.HELIA_AOT",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "HELIA_AOT",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "HELIA_AOT = 'helia-aot'",
              "source": {
                "line": 29,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L29"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalEngine.EXECUTORCH",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "EXECUTORCH",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "EXECUTORCH = 'executorch'",
              "source": {
                "line": 30,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L30"
              },
              "summary": ""
            }
          ],
          "name": "CanonicalEngine",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "CanonicalEngine()",
          "source": {
            "line": 24,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L24"
          },
          "summary": "An inference engine, by its shared name."
        },
        {
          "description": "A kernel library, by its shared name.\n\n``CMSIS_NN`` is Arm's CMSIS-NN. ``HELIA_CORE`` is heliaCORE, the product\nname of Ambiq's ``ns-cmsis-nn`` library.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.CanonicalKernel",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalKernel.REFERENCE",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "REFERENCE",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "REFERENCE = 'reference'",
              "source": {
                "line": 40,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L40"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalKernel.CMSIS_NN",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "CMSIS_NN",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "CMSIS_NN = 'cmsis-nn'",
              "source": {
                "line": 41,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L41"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.CanonicalKernel.HELIA_CORE",
              "kind": "constant",
              "language": "python",
              "members": [],
              "name": "HELIA_CORE",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "HELIA_CORE = 'helia-core'",
              "source": {
                "line": 42,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L42"
              },
              "summary": ""
            }
          ],
          "name": "CanonicalKernel",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "CanonicalKernel()",
          "source": {
            "line": 33,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L33"
          },
          "summary": "A kernel library, by its shared name."
        },
        {
          "description": "`dataclass`\n\nA fact that could not be determined, with the reason.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.Unknown",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.Unknown.reason",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "reason",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "reason: str",
              "source": {
                "line": 49,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L49"
              },
              "summary": ""
            }
          ],
          "name": "Unknown",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Unknown(reason: str) -> None",
          "source": {
            "line": 45,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L45"
          },
          "summary": "A fact that could not be determined, with the reason."
        },
        {
          "description": "`dataclass`\n\nA hash that names its producer, its kind and its basis version.\n\nThe text form is ``<producer>.<kind>/<version>:sha256:<hex>``: producer\nand kind are lowercase words joined by ``-``, the version a positive\ninteger, and the hex 64 lowercase digits. heliaPROFILER's hashes have\nthe producer ``hpx`` and the kinds ``intent``, ``build``,\n``observation``, ``binding``, ``inputs`` and ``target-config``; :meth:`parse` reads any\nproducer's.\nCompare two hashes only when their producer, kind and version match.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.SemanticHash",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.SemanticHash.producer",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "producer",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "producer: str",
              "source": {
                "line": 84,
                "path": "src/helia_profiler/_semantic_hash.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L84"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.SemanticHash.kind",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kind",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kind: str",
              "source": {
                "line": 85,
                "path": "src/helia_profiler/_semantic_hash.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L85"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.SemanticHash.version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "version: int",
              "source": {
                "line": 86,
                "path": "src/helia_profiler/_semantic_hash.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L86"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.SemanticHash.hex",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hex",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hex: str",
              "source": {
                "line": 87,
                "path": "src/helia_profiler/_semantic_hash.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L87"
              },
              "summary": ""
            },
            {
              "description": "`classmethod`\n\nRead *text*, refusing anything not in the semantic hash form.",
              "examples": [],
              "id": "helia_profiler.SemanticHash.parse",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "parse",
              "params": [],
              "raises": [
                {
                  "description": "*text* is not ``<producer>.<kind>/<version>:sha256:<hex>``,\nfor example bare hex, uppercase hex or a missing version.",
                  "type": "ValueError"
                }
              ],
              "returns": [],
              "signature": "parse(text: str) -> SemanticHash",
              "source": {
                "line": 97,
                "path": "src/helia_profiler/_semantic_hash.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L97"
              },
              "summary": "Read text, refusing anything not in the semantic hash form."
            }
          ],
          "name": "SemanticHash",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SemanticHash(producer: str, kind: str, version: int, hex: str) -> None",
          "source": {
            "line": 71,
            "path": "src/helia_profiler/_semantic_hash.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/_semantic_hash.py#L71"
          },
          "summary": "A hash that names its producer, its kind and its basis version."
        },
        {
          "description": "The shared name for an engine, from its canonical name or any alias.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.canonical_engine",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "canonical_engine",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "canonical_engine(name: str) -> CanonicalEngine",
          "source": {
            "line": 84,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L84"
          },
          "summary": "The shared name for an engine, from its canonical name or any alias."
        },
        {
          "description": "The shared name for a kernel library, from its canonical name or any alias.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.canonical_kernel",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "canonical_kernel",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "canonical_kernel(name: str) -> CanonicalKernel",
          "source": {
            "line": 89,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L89"
          },
          "summary": "The shared name for a kernel library, from its canonical name or any alias."
        },
        {
          "description": "`dataclass`\n\nThe runtime a build linked: its engine, source repository, version and commit.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RuntimeIdentity",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeIdentity.engine",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "engine",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "engine: CanonicalEngine",
              "source": {
                "line": 109,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L109"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeIdentity.repository",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "repository",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "repository: str | Unknown",
              "source": {
                "line": 110,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L110"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeIdentity.version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "version: str | Unknown",
              "source": {
                "line": 111,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L111"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RuntimeIdentity.commit",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "commit",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "commit: str | Unknown",
              "source": {
                "line": 112,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L112"
              },
              "summary": ""
            }
          ],
          "name": "RuntimeIdentity",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RuntimeIdentity(\n    engine: CanonicalEngine,\n    repository: str | Unknown,\n    version: str | Unknown,\n    commit: str | Unknown,\n) -> None",
          "source": {
            "line": 105,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L105"
          },
          "summary": "The runtime a build linked: its engine, source repository, version and commit."
        },
        {
          "description": "`dataclass`\n\nThe kernel library a build linked, taken from the module or archive it linked.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.KernelIdentity",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.KernelIdentity.library",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "library",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "library: CanonicalKernel | Unknown",
              "source": {
                "line": 119,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L119"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.KernelIdentity.repository",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "repository",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "repository: str | Unknown",
              "source": {
                "line": 120,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L120"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.KernelIdentity.version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "version: str | Unknown",
              "source": {
                "line": 121,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L121"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.KernelIdentity.commit",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "commit",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "commit: str | Unknown",
              "source": {
                "line": 122,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L122"
              },
              "summary": ""
            }
          ],
          "name": "KernelIdentity",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "KernelIdentity(\n    library: CanonicalKernel | Unknown,\n    repository: str | Unknown,\n    version: str | Unknown,\n    commit: str | Unknown,\n) -> None",
          "source": {
            "line": 115,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L115"
          },
          "summary": "The kernel library a build linked, taken from the module or archive it linked."
        },
        {
          "description": "`dataclass`\n\nHow the image was built and placed.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.BuildFacts",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.toolchain",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "toolchain",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "toolchain: str | Unknown",
              "source": {
                "line": 129,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L129"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.toolchain_version",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "toolchain_version",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "toolchain_version: str | Unknown",
              "source": {
                "line": 130,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L130"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.board",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "board",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "board: str",
              "source": {
                "line": 131,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L131"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.cpu_hz",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "cpu_hz",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "cpu_hz: int | Unknown",
              "source": {
                "line": 132,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L132"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.clock_profile",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "clock_profile",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "clock_profile: str | Unknown",
              "source": {
                "line": 133,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L133"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.arena_location",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "arena_location",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "arena_location: str | Unknown",
              "source": {
                "line": 134,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L134"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.weights_location",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "weights_location",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "weights_location: str | Unknown",
              "source": {
                "line": 135,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L135"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.BuildFacts.arena_bytes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "arena_bytes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "arena_bytes: int | Unknown",
              "source": {
                "line": 136,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L136"
              },
              "summary": ""
            }
          ],
          "name": "BuildFacts",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "BuildFacts(\n    toolchain: str | Unknown,\n    toolchain_version: str | Unknown,\n    board: str,\n    cpu_hz: int | Unknown,\n    clock_profile: str | Unknown,\n    arena_location: str | Unknown,\n    weights_location: str | Unknown,\n    arena_bytes: int | Unknown,\n) -> None",
          "source": {
            "line": 125,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L125"
          },
          "summary": "How the image was built and placed."
        },
        {
          "description": "`dataclass`\n\nThe method a run's energy is measured with, whether or not the capture succeeded.\n\n``scope`` is what the measured window covers:\n``gross_rail_restore_and_invoke`` is everything the rail draws over the\ntimed restore-and-invoke loop. ``rail`` is the physical rail the run\nmeasures, such as ``MCU``: the rail requested, also after a failed\ncapture, and unknown only where no request is at hand, as in a build's\nidentity before it runs. ``subtraction`` is what is taken off the\nmeasurement, ``none`` when nothing is. ``completion_protocol`` is the\nversion of the firmware's READY, GO and DONE handshake that bounds the\nwindow. The measurement itself, or its absence, is the run's outcome,\nsuch as ``RunResult.energy``.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.EnergyFacts",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.EnergyFacts.scope",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scope",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scope: str",
              "source": {
                "line": 158,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L158"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.EnergyFacts.rail",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "rail",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "rail: str | Unknown",
              "source": {
                "line": 159,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L159"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.EnergyFacts.subtraction",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "subtraction",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "subtraction: str",
              "source": {
                "line": 160,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L160"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.EnergyFacts.completion_protocol",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "completion_protocol",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "completion_protocol: int",
              "source": {
                "line": 161,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L161"
              },
              "summary": ""
            }
          ],
          "name": "EnergyFacts",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "EnergyFacts(scope: str, rail: str | Unknown, subtraction: str, completion_protocol: int) -> None",
          "source": {
            "line": 142,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L142"
          },
          "summary": "The method a run's energy is measured with, whether or not the capture succeeded."
        },
        {
          "description": "`dataclass`\n\nHow the model was run: state handling, invocation counts, the timed span and its clock.\n\n``timing_scope`` is what each timed span covers: ``invoke_only`` or\n``restore_and_invoke``, which also restores the fixed inputs.\n``instance_boundary`` is where one model instance ends: ``boot`` when the\nengine initializes once and every invocation reuses it, ``invocation``\nwhen each invocation loads and initializes its own.\n``first_invoke_initializer`` is whether the first invocation of an\ninstance runs the model's one-time initializer, such as a LiteRT\n``CALL_ONCE`` subgraph, and ``first_invoke_window`` where that invocation\nfalls: ``warmup`` or ``measured``. ``timing_clock`` is the clock that times\nthe span, ``cpu`` cycles or the 32.768 kHz ``stimer``; ``timing_clock_hz``\nis its configured rate, not a measured one. ``timing_statistic`` is what\nthe reported time is: the ``total`` over the measured invocations or\ntheir ``mean``. ``energy`` is the method the run's energy is measured\nwith, stated after a failed capture too, and ``None`` when the run\nmeasures no energy; whether it was measured is the outcome, not a fact\nhere.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RunFacts",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.lifecycle",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "lifecycle",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "lifecycle: str",
              "source": {
                "line": 186,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L186"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.iterations",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "iterations",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "iterations: int",
              "source": {
                "line": 187,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L187"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.warmups",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "warmups",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "warmups: int",
              "source": {
                "line": 188,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L188"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.timing_scope",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "timing_scope",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "timing_scope: str",
              "source": {
                "line": 189,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L189"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.instance_boundary",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "instance_boundary",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "instance_boundary: str | Unknown = _UNRECORDED",
              "source": {
                "line": 190,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L190"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.first_invoke_initializer",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "first_invoke_initializer",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "first_invoke_initializer: bool | Unknown = _UNRECORDED",
              "source": {
                "line": 191,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L191"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.first_invoke_window",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "first_invoke_window",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "first_invoke_window: str | Unknown = _UNRECORDED",
              "source": {
                "line": 192,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L192"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.timing_clock",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "timing_clock",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "timing_clock: str | Unknown = _UNRECORDED",
              "source": {
                "line": 193,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L193"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.timing_clock_hz",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "timing_clock_hz",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "timing_clock_hz: int | Unknown = _UNRECORDED",
              "source": {
                "line": 194,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L194"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.timing_statistic",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "timing_statistic",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "timing_statistic: str | Unknown = _UNRECORDED",
              "source": {
                "line": 195,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L195"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunFacts.energy",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "energy",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "energy: EnergyFacts | Unknown | None = None",
              "source": {
                "line": 196,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L196"
              },
              "summary": ""
            }
          ],
          "name": "RunFacts",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RunFacts(\n    lifecycle: str,\n    iterations: int,\n    warmups: int,\n    timing_scope: str,\n    instance_boundary: str | Unknown = _UNRECORDED,\n    first_invoke_initializer: bool | Unknown = _UNRECORDED,\n    first_invoke_window: str | Unknown = _UNRECORDED,\n    timing_clock: str | Unknown = _UNRECORDED,\n    timing_clock_hz: int | Unknown = _UNRECORDED,\n    timing_statistic: str | Unknown = _UNRECORDED,\n    energy: EnergyFacts | Unknown | None = None,\n) -> None",
          "source": {
            "line": 164,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L164"
          },
          "summary": "How the model was run: state handling, invocation counts, the timed span and its clock."
        },
        {
          "description": "`dataclass`\n\nEverything a comparison needs to know about what ran.\n\n``build_hash`` covers the flashed image, the dependency lock, the linked\nruntime archive and the model, and never the HPX release (``producer``),\nso it changes only when what runs changes. ``observation_hash`` covers a\ncapture's measured facts, so the same firmware measured twice gives two.\n``intent_hash`` is the :attr:`~helia_profiler.FrozenRun.intent_hash` of\nthe plan a run was built from, and ``None`` for a run built without one.\n``inputs_hash`` covers each pinned input's tensor name and data sha256.\nThe four are :class:`~helia_profiler.SemanticHash` strings of the kinds\n``hpx.build``, ``hpx.observation``, ``hpx.intent`` and ``hpx.inputs``;\neach ``*_sha256`` fact is the bare hex sha256 of one file's bytes.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.RunIdentity",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.runtime",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "runtime",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "runtime: RuntimeIdentity",
              "source": {
                "line": 215,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L215"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.kernels",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernels",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernels: KernelIdentity",
              "source": {
                "line": 216,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L216"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.prepared_archive_sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "prepared_archive_sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "prepared_archive_sha256: str | None",
              "source": {
                "line": 217,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L217"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.build",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "build",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "build: BuildFacts",
              "source": {
                "line": 218,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L218"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.baseline_id",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "baseline_id",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "baseline_id: str | Unknown",
              "source": {
                "line": 219,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L219"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.dependency_lock_sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dependency_lock_sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dependency_lock_sha256: str | Unknown",
              "source": {
                "line": 220,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L220"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.model_sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_sha256: str | Unknown",
              "source": {
                "line": 221,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L221"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.inputs_hash",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "inputs_hash",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "inputs_hash: str | Unknown",
              "source": {
                "line": 222,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L222"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.run",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "run",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "run: RunFacts",
              "source": {
                "line": 223,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L223"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.producer",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "producer",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "producer: str | Unknown",
              "source": {
                "line": 224,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L224"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.build_hash",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "build_hash",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "build_hash: str | Unknown",
              "source": {
                "line": 225,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L225"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.observation_hash",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "observation_hash",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "observation_hash: str | None = None",
              "source": {
                "line": 226,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L226"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.RunIdentity.intent_hash",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "intent_hash",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "intent_hash: str | None = None",
              "source": {
                "line": 227,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L227"
              },
              "summary": ""
            },
            {
              "description": "JSON-ready form; an unknown fact becomes ``{\"unknown\": reason}``.",
              "examples": [],
              "id": "helia_profiler.RunIdentity.to_dict",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "to_dict",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "to_dict() -> dict[str, Any]",
              "source": {
                "line": 229,
                "path": "src/helia_profiler/identity.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L229"
              },
              "summary": "JSON-ready form; an unknown fact becomes {\"unknown\": reason}."
            }
          ],
          "name": "RunIdentity",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RunIdentity(\n    runtime: RuntimeIdentity,\n    kernels: KernelIdentity,\n    prepared_archive_sha256: str | None,\n    build: BuildFacts,\n    baseline_id: str | Unknown,\n    dependency_lock_sha256: str | Unknown,\n    model_sha256: str | Unknown,\n    inputs_hash: str | Unknown,\n    run: RunFacts,\n    producer: str | Unknown,\n    build_hash: str | Unknown,\n    observation_hash: str | None = None,\n    intent_hash: str | None = None,\n) -> None",
          "source": {
            "line": 199,
            "path": "src/helia_profiler/identity.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/identity.py#L199"
          },
          "summary": "Everything a comparison needs to know about what ran."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}