{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "The static cost model of a network, read from the model file before anything is built or run.\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": "modelcost",
      "path": "helia_profiler.modelcost",
      "submodules": [],
      "summary": "The static cost model of a network, read from the model file before anything is built or run.",
      "symbols": [
        {
          "description": "`dataclass`\n\nFull model analysis result.\n\n**API tier:** `experimental`",
          "examples": [],
          "id": "helia_profiler.ModelAnalysis",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.layers",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "layers",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "layers: list[LayerOps]",
              "source": {
                "line": 169,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L169"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.total_macs",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "total_macs",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "total_macs: int",
              "source": {
                "line": 170,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L170"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.total_ops",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "total_ops",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "total_ops: int",
              "source": {
                "line": 171,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L171"
              },
              "summary": ""
            },
            {
              "description": "Approximate parameter count (weights + biases).",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.num_parameters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "num_parameters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "num_parameters: int",
              "source": {
                "line": 172,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L172"
              },
              "summary": "Approximate parameter count (weights + biases)."
            },
            {
              "description": "Engine/interpreter that produced this analysis ('tflite', 'helia-rt', 'helia-aot').",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.engine",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "engine",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "engine: str = 'tflite'",
              "source": {
                "line": 174,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L174"
              },
              "summary": "Engine/interpreter that produced this analysis ('tflite', 'helia-rt', 'helia-aot')."
            },
            {
              "description": "Number of Vela-generated ethos-u custom ops in the graph.",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.ethos_u_op_count",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "ethos_u_op_count",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "ethos_u_op_count: int",
              "source": {
                "line": 182,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L182"
              },
              "summary": "Number of Vela-generated ethos-u custom ops in the graph."
            },
            {
              "description": "True when the model was compiled by Vela (contains ethos-u ops).",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.has_ethos_u_op",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "has_ethos_u_op",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "has_ethos_u_op: bool",
              "source": {
                "line": 187,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L187"
              },
              "summary": "True when the model was compiled by Vela (contains ethos-u ops)."
            },
            {
              "description": "Return the analysis and its layers as plain dicts.",
              "examples": [],
              "id": "helia_profiler.ModelAnalysis.to_dict",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "to_dict",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "to_dict() -> dict[str, Any]",
              "source": {
                "line": 177,
                "path": "src/helia_profiler/modelcost/model_analysis.py",
                "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L177"
              },
              "summary": "Return the analysis and its layers as plain dicts."
            }
          ],
          "name": "ModelAnalysis",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ModelAnalysis(\n    layers: list[LayerOps],\n    total_macs: int,\n    total_ops: int,\n    num_parameters: int,\n    engine: str = 'tflite',\n) -> None",
          "source": {
            "line": 165,
            "path": "src/helia_profiler/modelcost/model_analysis.py",
            "url": "https://github.com/AmbiqAI/helia-profiler/blob/main/src/helia_profiler/modelcost/model_analysis.py#L165"
          },
          "summary": "Full model analysis result."
        }
      ]
    }
  ],
  "name": "helia_profiler"
}