{
  "$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 conformer family; importable without Keras.",
      "name": "conformer_params",
      "path": "helia_edge.models.conformer_params",
      "submodules": [],
      "summary": "Typed parameters of the conformer family; importable without Keras.",
      "symbols": [
        {
          "description": "Subsample block parameters",
          "examples": [],
          "id": "helia_edge.models.conformer_params.SubsampleBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.conformer_params.SubsampleBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 17,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L17"
              },
              "summary": ""
            },
            {
              "description": "Depth",
              "examples": [],
              "id": "helia_edge.models.conformer_params.SubsampleBlockParams.depth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "depth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "depth: int = 256",
              "source": {
                "line": 19,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L19"
              },
              "summary": ""
            },
            {
              "description": "Kernel size",
              "examples": [],
              "id": "helia_edge.models.conformer_params.SubsampleBlockParams.kernel_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel_size: int = 3",
              "source": {
                "line": 20,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L20"
              },
              "summary": ""
            },
            {
              "description": "Stride size",
              "examples": [],
              "id": "helia_edge.models.conformer_params.SubsampleBlockParams.strides",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "strides",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "strides: int = 2",
              "source": {
                "line": 21,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L21"
              },
              "summary": ""
            }
          ],
          "name": "SubsampleBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "SubsampleBlockParams()",
          "source": {
            "line": 8,
            "path": "helia_edge/models/conformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L8"
          },
          "summary": "Subsample block parameters"
        },
        {
          "description": "Conformer block parameters",
          "examples": [],
          "id": "helia_edge.models.conformer_params.ConformerBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 38,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L38"
              },
              "summary": ""
            },
            {
              "description": "Depth",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.depth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "depth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "depth: int = 256",
              "source": {
                "line": 40,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L40"
              },
              "summary": ""
            },
            {
              "description": "FC expansion factor",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.fc_ex_factor",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "fc_ex_factor",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "fc_ex_factor: float = 4",
              "source": {
                "line": 41,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L41"
              },
              "summary": ""
            },
            {
              "description": "FC residual factor",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.fc_res_factor",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "fc_res_factor",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "fc_res_factor: float = 0.5",
              "source": {
                "line": 42,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L42"
              },
              "summary": ""
            },
            {
              "description": "Embedding type",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.embedding",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "embedding",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "embedding: str = 'relative'",
              "source": {
                "line": 43,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L43"
              },
              "summary": ""
            },
            {
              "description": "Number of heads",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.num_heads",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "num_heads",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "num_heads: int = 4",
              "source": {
                "line": 44,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L44"
              },
              "summary": ""
            },
            {
              "description": "Kernel size",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.kernel_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel_size: int = 9",
              "source": {
                "line": 45,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L45"
              },
              "summary": ""
            },
            {
              "description": "Dropout rate",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.dropout",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dropout",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dropout: float = 0.1",
              "source": {
                "line": 46,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L46"
              },
              "summary": ""
            },
            {
              "description": "Use bias",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerBlockParams.use_bias",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "use_bias",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "use_bias: bool = True",
              "source": {
                "line": 47,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L47"
              },
              "summary": ""
            }
          ],
          "name": "ConformerBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ConformerBlockParams()",
          "source": {
            "line": 24,
            "path": "helia_edge/models/conformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L24"
          },
          "summary": "Conformer block parameters"
        },
        {
          "description": "Conformer parameters",
          "examples": [],
          "id": "helia_edge.models.conformer_params.ConformerParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 63,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L63"
              },
              "summary": ""
            },
            {
              "description": "Model family",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['conformer'] = 'conformer'",
              "source": {
                "line": 65,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L65"
              },
              "summary": ""
            },
            {
              "description": "Subsample blocks",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.subsamples",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "subsamples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "subsamples: list[SubsampleBlockParams] = Field(default_factory=list, description='Subsample blocks')",
              "source": {
                "line": 66,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L66"
              },
              "summary": ""
            },
            {
              "description": "Conformer blocks",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.blocks",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "blocks",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "blocks: list[ConformerBlockParams] = Field(default_factory=list, description='Conformer blocks')",
              "source": {
                "line": 67,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L67"
              },
              "summary": ""
            },
            {
              "description": "Output activation",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.output_activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_activation: str | None = Field(default=None, description='Output activation')",
              "source": {
                "line": 68,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L68"
              },
              "summary": ""
            },
            {
              "description": "Include top",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.include_top",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "include_top",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "include_top: bool = Field(default=True, description='Include top')",
              "source": {
                "line": 69,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L69"
              },
              "summary": ""
            },
            {
              "description": "Classes of the output layer",
              "examples": [],
              "id": "helia_edge.models.conformer_params.ConformerParams.num_classes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "num_classes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "num_classes: int | None = Field(default=None, gt=0, description='Classes of the output layer')",
              "source": {
                "line": 70,
                "path": "helia_edge/models/conformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L70"
              },
              "summary": ""
            }
          ],
          "name": "ConformerParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ConformerParams()",
          "source": {
            "line": 50,
            "path": "helia_edge/models/conformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/conformer_params.py#L50"
          },
          "summary": "Conformer parameters"
        }
      ]
    }
  ],
  "name": "helia_edge"
}