{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "f341fb11f7f5d77a4974ba8273c4cd55d67c21f0",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "Export results and the environment that produced them; importable without Keras.",
      "name": "result",
      "path": "helia_edge.export.result",
      "submodules": [],
      "summary": "Export results and the environment that produced them; importable without Keras.",
      "symbols": [
        {
          "description": "",
          "examples": [],
          "id": "helia_edge.export.result.HeliaEdgeSource",
          "kind": "attribute",
          "language": "python",
          "members": [],
          "name": "HeliaEdgeSource",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "HeliaEdgeSource = Literal['release', 'vcs', 'local', 'unknown']",
          "source": {
            "line": 17,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L17"
          },
          "summary": ""
        },
        {
          "description": "`dataclass`\n\nOne model input or output. Dynamic dimensions are -1. I/O tensors are per-tensor quantized; float\ntensors have no scale. A state tensor (``role`` STATE) has the index ``pair`` of its state pair.",
          "examples": [],
          "id": "helia_edge.export.result.TensorRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.name",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "name",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "name: str",
              "source": {
                "line": 25,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L25"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.role",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "role",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "role: TensorRole",
              "source": {
                "line": 26,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L26"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.shape",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "shape",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "shape: tuple[int, ...]",
              "source": {
                "line": 27,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L27"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.dtype",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dtype",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dtype: IODType",
              "source": {
                "line": 28,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L28"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.scale",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scale",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scale: float | None",
              "source": {
                "line": 29,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L29"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.zero_point",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "zero_point",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "zero_point: int | None",
              "source": {
                "line": 30,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L30"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.TensorRecord.pair",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "pair",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "pair: int | None = None",
              "source": {
                "line": 31,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L31"
              },
              "summary": ""
            }
          ],
          "name": "TensorRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TensorRecord(\n    name: str,\n    role: TensorRole,\n    shape: tuple[int, ...],\n    dtype: IODType,\n    scale: float | None,\n    zero_point: int | None,\n    pair: int | None = None,\n) -> None",
          "source": {
            "line": 20,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L20"
          },
          "summary": "One model input or output."
        },
        {
          "description": "Whether every integer state pair has one scale and zero point.",
          "examples": [],
          "id": "helia_edge.export.result.state_scales_tied",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "state_scales_tied",
          "params": [],
          "raises": [
            {
              "description": "If a state tensor has no pair index, or a state input or output has no partner.",
              "type": "ValueError"
            }
          ],
          "returns": [
            {
              "description": "bool | None: None when the model has no integer state pair, as for float I/O or a stateless model.",
              "type": "bool | None"
            }
          ],
          "signature": "state_scales_tied(inputs: Sequence[TensorRecord], outputs: Sequence[TensorRecord]) -> bool | None",
          "source": {
            "line": 44,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L44"
          },
          "summary": "Whether every integer state pair has one scale and zero point."
        },
        {
          "description": "`dataclass`\n\nVersions that can change exported bytes.\n\n``helia_edge`` is ``\"unknown\"`` when the imported package is not the installed distribution (for\nexample a source tree on ``PYTHONPATH``). ``helia_edge_commit`` is set only for a distribution\ninstalled from a VCS URL. ``helia_edge_source`` says how the version identifies the code: ``release``\n(installed from a package index), ``vcs`` (installed from a VCS URL at ``helia_edge_commit``),\n``local`` (installed from a directory or an archive, or a source tree with egg-info metadata, which\nthe version does not identify) or ``unknown``.",
          "examples": [],
          "id": "helia_edge.export.result.EnvironmentRecord",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.helia_edge",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "helia_edge",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "helia_edge: str",
              "source": {
                "line": 74,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L74"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.helia_edge_commit",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "helia_edge_commit",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "helia_edge_commit: str | None",
              "source": {
                "line": 75,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L75"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.python",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "python",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "python: str",
              "source": {
                "line": 76,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L76"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.platform",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "platform",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "platform: str",
              "source": {
                "line": 77,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L77"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.packages",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "packages",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "packages: tuple[tuple[str, str | None], ...]",
              "source": {
                "line": 78,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L78"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.helia_edge_source",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "helia_edge_source",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "helia_edge_source: HeliaEdgeSource = 'unknown'",
              "source": {
                "line": 79,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L79"
              },
              "summary": ""
            },
            {
              "description": "True when the recorded version or commit identifies the code that ran.",
              "examples": [],
              "id": "helia_edge.export.result.EnvironmentRecord.identified",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "identified",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "identified: bool",
              "source": {
                "line": 82,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L82"
              },
              "summary": "True when the recorded version or commit identifies the code that ran."
            }
          ],
          "name": "EnvironmentRecord",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "EnvironmentRecord(\n    helia_edge: str,\n    helia_edge_commit: str | None,\n    python: str,\n    platform: str,\n    packages: tuple[tuple[str, str | None], ...],\n    helia_edge_source: HeliaEdgeSource = 'unknown',\n) -> None",
          "source": {
            "line": 62,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L62"
          },
          "summary": "Versions that can change exported bytes."
        },
        {
          "description": "`dataclass`\n\nExported model bytes with their identity.",
          "examples": [],
          "id": "helia_edge.export.result.ExportResult",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.spec",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "spec",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "spec: ExportSpec",
              "source": {
                "line": 91,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L91"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.content",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "content",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "content: bytes",
              "source": {
                "line": 92,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L92"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.sha256",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "sha256",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "sha256: str",
              "source": {
                "line": 93,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L93"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.inputs",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "inputs",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "inputs: tuple[TensorRecord, ...]",
              "source": {
                "line": 94,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L94"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.outputs",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "outputs",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "outputs: tuple[TensorRecord, ...]",
              "source": {
                "line": 95,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L95"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.export.result.ExportResult.environment",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "environment",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "environment: EnvironmentRecord",
              "source": {
                "line": 96,
                "path": "helia_edge/export/result.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L96"
              },
              "summary": ""
            }
          ],
          "name": "ExportResult",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ExportResult(\n    spec: ExportSpec,\n    content: bytes,\n    sha256: str,\n    inputs: tuple[TensorRecord, ...],\n    outputs: tuple[TensorRecord, ...],\n    environment: EnvironmentRecord,\n) -> None",
          "source": {
            "line": 87,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L87"
          },
          "summary": "Exported model bytes with their identity."
        },
        {
          "description": "Describe the running environment.",
          "examples": [],
          "id": "helia_edge.export.result.environment_record",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "environment_record",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "environment_record() -> EnvironmentRecord",
          "source": {
            "line": 131,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L131"
          },
          "summary": "Describe the running environment."
        },
        {
          "description": "Why ``record`` does not identify the helia-edge code, and how to install code that does.",
          "examples": [],
          "id": "helia_edge.export.result.unidentified_install",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "unidentified_install",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "unidentified_install(record: EnvironmentRecord) -> str",
          "source": {
            "line": 144,
            "path": "helia_edge/export/result.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/export/result.py#L144"
          },
          "summary": "Why record does not identify the helia-edge code, and how to install code that does."
        }
      ]
    }
  ],
  "name": "helia_edge"
}