{
  "$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": "Typed parameters of the Silero VAD v6 streaming model and its weight mapping; importable without Keras.",
      "name": "silero_vad_params",
      "path": "helia_edge.models.silero_vad_params",
      "submodules": [],
      "summary": "Typed parameters of the Silero VAD v6 streaming model and its weight mapping; importable without Keras.",
      "symbols": [
        {
          "description": "Mapping of every weight of the Silero VAD v6 model (``build(SileroVadParams())``) from the pinned v6.2.2\nONNX file.",
          "examples": [],
          "id": "helia_edge.models.silero_vad_params.SILERO_VAD_V6_ONNX",
          "kind": "constant",
          "language": "python",
          "members": [],
          "name": "SILERO_VAD_V6_ONNX",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SILERO_VAD_V6_ONNX = WeightMapping(name='silero_vad_v6_onnx', source=SourcePin(uri='https://github.com/snakers4/silero-vad/raw/60b7ffa243625ebdc1070275a29f18c87843786a/src/silero_vad/data/silero_vad_16k_op15.onnx', sha256='7ed98ddbad84ccac4cd0aeb3099049280713df825c610a8ed34543318f1b2c49', format='onnx', note='v6.2.2, MIT. silero_vad_16k.safetensors in the same repository holds different weights.'), rows=(WeightRow(sources=('model.stft.forward_basis_buffer'), transforms=(Transpose(perm=(2, 1, 0))), layer='stft', weight='basis'), *_conv(0), *_conv(1), *_conv(2), *_conv(3), WeightRow(sources=('model.decoder.rnn.weight_ih'), transforms=(Transpose(perm=(1, 0))), layer='lstm', weight='kernel'), WeightRow(sources=('model.decoder.rnn.weight_hh'), transforms=(Transpose(perm=(1, 0))), layer='lstm', weight='recurrent_kernel'), WeightRow(sources=('model.decoder.rnn.bias_ih', 'model.decoder.rnn.bias_hh'), combine='sum', layer='lstm', weight='bias'), WeightRow(sources=('model.decoder.decoder.2.weight'), source_shape=(1, SileroVadParams().units, 1), transforms=(Reshape(shape=(SileroVadParams().units, 1))), layer='prob', weight='kernel'), WeightRow(sources=('model.decoder.decoder.2.bias'), layer='prob', weight='bias')))",
          "source": {
            "line": 66,
            "path": "helia_edge/models/silero_vad_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L66"
          },
          "summary": "Mapping of every weight of the Silero VAD v6 model (build(SileroVadParams())) from the pinned v6.2.2 ONNX file."
        },
        {
          "description": "Weight mappings for this family, by name.",
          "examples": [],
          "id": "helia_edge.models.silero_vad_params.MAPPINGS",
          "kind": "constant",
          "language": "python",
          "members": [],
          "name": "MAPPINGS",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MAPPINGS: dict[str, WeightMapping] = {SILERO_VAD_V6_ONNX.name: SILERO_VAD_V6_ONNX}",
          "source": {
            "line": 118,
            "path": "helia_edge/models/silero_vad_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L118"
          },
          "summary": "Weight mappings for this family, by name."
        },
        {
          "description": "Silero VAD v6 (16 kHz). The geometry is fixed by the v6.2.2 weights; the options choose how the\nmodel computes it. Every option has the same weights (paths and shapes), so one mapping imports into\neach; Keras ``.weights.h5`` files are keyed by layer class, so save one per option set.",
          "examples": [],
          "id": "helia_edge.models.silero_vad_params.SileroVadParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 31,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L31"
              },
              "summary": ""
            },
            {
              "description": "Model family.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['silero_vad'] = 'silero_vad'",
              "source": {
                "line": 33,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L33"
              },
              "summary": ""
            },
            {
              "description": "Audio sample rate in Hz.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.sample_rate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "sample_rate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "sample_rate: Literal[16000] = 16000",
              "source": {
                "line": 34,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L34"
              },
              "summary": ""
            },
            {
              "description": "Samples of the previous call repeated at the start of each call.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.context",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "context",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "context: Literal[64] = 64",
              "source": {
                "line": 35,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L35"
              },
              "summary": ""
            },
            {
              "description": "New samples per call (32 ms).",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.hop",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "hop",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "hop: Literal[512] = 512",
              "source": {
                "line": 36,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L36"
              },
              "summary": ""
            },
            {
              "description": "LSTM state size of ``state_in_0``/``state_in_1`` (h, c).",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.units",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "units",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "units: Literal[128] = 128",
              "source": {
                "line": 37,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L37"
              },
              "summary": ""
            },
            {
              "description": "``conv1d`` frames the reflect-padded audio with a strided convolution. ``conv_blocks``\nconvolves 64-sample blocks instead, with the right reflect padding folded into the last\nframe's kernel, so the export is mirror-pad-free; it is exact in float.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.stft",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "stft",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "stft: Literal['conv1d', 'conv_blocks'] = 'conv1d'",
              "source": {
                "line": 38,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L38"
              },
              "summary": ""
            },
            {
              "description": "``sqrt`` is the exact magnitude of each bin. ``max_projection`` is the largest of 9\nprojections of (|re|, |im|) onto directions from 0 to 90 degrees, within 0.25% in float32; it needs no\nsquare root, so the model exports to int16 activations.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.magnitude",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "magnitude",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "magnitude: Literal['sqrt', 'max_projection'] = 'sqrt'",
              "source": {
                "line": 39,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L39"
              },
              "summary": ""
            },
            {
              "description": "``conv`` runs the last two encoder layers as convolutions. ``live_taps`` runs them as\ndense layers over the kernel taps that see real frames rather than padding; it is exact in float.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.encoder_tail",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "encoder_tail",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "encoder_tail: Literal['conv', 'live_taps'] = 'conv'",
              "source": {
                "line": 40,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L40"
              },
              "summary": ""
            },
            {
              "description": "Samples per call: ``context + hop``.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.samples",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "samples: int",
              "source": {
                "line": 43,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L43"
              },
              "summary": "Samples per call: context + hop."
            },
            {
              "description": "The fixed audio shape ``(samples,)``, without the batch axis.",
              "examples": [],
              "id": "helia_edge.models.silero_vad_params.SileroVadParams.input_shape",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_shape",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_shape: tuple[int, ...]",
              "source": {
                "line": 48,
                "path": "helia_edge/models/silero_vad_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L48"
              },
              "summary": "The fixed audio shape (samples,), without the batch axis."
            }
          ],
          "name": "SileroVadParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SileroVadParams()",
          "source": {
            "line": 10,
            "path": "helia_edge/models/silero_vad_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/silero_vad_params.py#L10"
          },
          "summary": "Silero VAD v6 (16 kHz)."
        }
      ]
    }
  ],
  "name": "helia_edge"
}