{
  "$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": "Read named tensors from source files: ``path -> {name: array}``, one reader per ``SourceFormat``.\n\nThe ``onnx`` reader needs the ``onnx`` extra and the ``torch`` reader the ``torch`` extra; both are\nimported only when called. The ``safetensors`` reader uses NumPy alone.",
      "name": "readers",
      "path": "helia_edge.importers.readers",
      "submodules": [],
      "summary": "Read named tensors from source files: path -> {name: array}, one reader per SourceFormat.",
      "symbols": [
        {
          "description": "The initializers of a self-contained ``.onnx`` model, by name.\n\nWeights held in ``Constant`` nodes rather than initializers are not read; such a source tensor is\nreported as not in the file.",
          "examples": [],
          "id": "helia_edge.importers.readers.read_onnx",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "read_onnx",
          "params": [],
          "raises": [
            {
              "description": "If an initializer is stored in a separate data file, which the source's sha256 does\nnot cover.",
              "type": "ValueError"
            }
          ],
          "returns": [],
          "signature": "read_onnx(path: Path) -> dict[str, npt.NDArray]",
          "source": {
            "line": 29,
            "path": "helia_edge/importers/readers.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/importers/readers.py#L29"
          },
          "summary": "The initializers of a self-contained .onnx model, by name."
        },
        {
          "description": "The tensors of a ``.safetensors`` file, by name (little-endian; BF16 is not supported).",
          "examples": [],
          "id": "helia_edge.importers.readers.read_safetensors",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "read_safetensors",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "read_safetensors(path: Path) -> dict[str, npt.NDArray]",
          "source": {
            "line": 54,
            "path": "helia_edge/importers/readers.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/importers/readers.py#L54"
          },
          "summary": "The tensors of a .safetensors file, by name (little-endian; BF16 is not supported)."
        },
        {
          "description": "The tensors of a PyTorch state dict saved with ``torch.save``, loaded with ``weights_only=True``.",
          "examples": [],
          "id": "helia_edge.importers.readers.read_torch",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "read_torch",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "read_torch(path: Path) -> dict[str, npt.NDArray]",
          "source": {
            "line": 71,
            "path": "helia_edge/importers/readers.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/importers/readers.py#L71"
          },
          "summary": "The tensors of a PyTorch state dict saved with torch.save, loaded with weightsonly=True."
        },
        {
          "description": "The tensors of the file at ``path``, read as ``format``.",
          "examples": [],
          "id": "helia_edge.importers.readers.read",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "read",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "read(format: SourceFormat, path: Path) -> dict[str, npt.NDArray]",
          "source": {
            "line": 89,
            "path": "helia_edge/importers/readers.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/importers/readers.py#L89"
          },
          "summary": "The tensors of the file at path, read as format."
        }
      ]
    }
  ],
  "name": "helia_edge"
}
