{
  "$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": "# Tensor Utility API\n\nThis module provides utility functions for working with tensors.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `matches_spec` | Test whether data object matches the desired spec |",
      "name": "tensor",
      "path": "helia_edge.utils.tensor",
      "submodules": [],
      "summary": "Tensor Utility API",
      "symbols": [
        {
          "description": "",
          "examples": [],
          "id": "helia_edge.utils.tensor.SpecType",
          "kind": "attribute",
          "language": "python",
          "members": [],
          "name": "SpecType",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SpecType = list[npt.ArrayLike] | tuple[npt.ArrayLike] | dict[str, npt.ArrayLike] | npt.ArrayLike",
          "source": {
            "line": 13,
            "path": "helia_edge/utils/tensor.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/utils/tensor.py#L13"
          },
          "summary": ""
        },
        {
          "description": "Test whether data object matches the desired spec.",
          "examples": [],
          "id": "helia_edge.utils.tensor.matches_spec",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "matches_spec",
          "params": [
            {
              "description": "Data object.",
              "name": "o",
              "type": "SpecType"
            },
            {
              "description": "Metadata for describing the the data object.",
              "name": "spec",
              "type": "SpecType"
            },
            {
              "default": "False",
              "description": "Ignore first dimension when checking shapes.",
              "name": "ignore_batch_dim",
              "type": "bool"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "If matches",
              "name": "bool",
              "type": "bool"
            }
          ],
          "signature": "matches_spec(o: SpecType, spec: SpecType, ignore_batch_dim: bool = False) -> bool",
          "source": {
            "line": 16,
            "path": "helia_edge/utils/tensor.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/utils/tensor.py#L16"
          },
          "summary": "Test whether data object matches the desired spec."
        }
      ]
    }
  ],
  "name": "helia_edge"
}