{
  "$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 TCN family; importable without Keras.",
      "name": "tcn_params",
      "path": "helia_edge.models.tcn_params",
      "submodules": [],
      "summary": "Typed parameters of the TCN family; importable without Keras.",
      "symbols": [
        {
          "description": "TCN block parameters",
          "examples": [],
          "id": "helia_edge.models.tcn_params.TcnBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 32,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L32"
              },
              "summary": ""
            },
            {
              "description": "Layer depth",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.depth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "depth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "depth: int = Field(default=1, gt=0, description='Layer depth')",
              "source": {
                "line": 34,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L34"
              },
              "summary": ""
            },
            {
              "description": "Number of branches",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.branch",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "branch",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "branch: int = Field(default=1, gt=0, description='Number of branches')",
              "source": {
                "line": 35,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L35"
              },
              "summary": ""
            },
            {
              "description": "Number of filters",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.filters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "filters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "filters: int = Field(..., gt=0, description='# filters')",
              "source": {
                "line": 36,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L36"
              },
              "summary": ""
            },
            {
              "description": "Kernel size",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.kernel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel: int | tuple[int, int] = Field(default=3, description='Kernel size')",
              "source": {
                "line": 37,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L37"
              },
              "summary": ""
            },
            {
              "description": "Dilation rate",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.dilation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dilation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dilation: int | tuple[int, int] = Field(default=1, description='Dilation rate')",
              "source": {
                "line": 38,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L38"
              },
              "summary": ""
            },
            {
              "description": "Expansion ratio",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.ex_ratio",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "ex_ratio",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "ex_ratio: float = Field(default=1, gt=0, allow_inf_nan=False, description='Expansion ratio')",
              "source": {
                "line": 39,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L39"
              },
              "summary": ""
            },
            {
              "description": "Squeeze and excite ratio",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.se_ratio",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "se_ratio",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "se_ratio: float = Field(default=0, ge=0, allow_inf_nan=False, description='Squeeze and excite ratio')",
              "source": {
                "line": 40,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L40"
              },
              "summary": ""
            },
            {
              "description": "Dropout rate",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.dropout",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dropout",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dropout: float | None = Field(default=None, ge=0, lt=1, allow_inf_nan=False, description='Dropout rate')",
              "source": {
                "line": 41,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L41"
              },
              "summary": ""
            },
            {
              "description": "Normalization type",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.norm",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "norm",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "norm: Literal['batch', 'layer'] | None = Field(default='layer', description='Normalization type')",
              "source": {
                "line": 42,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L42"
              },
              "summary": ""
            },
            {
              "description": "Activation function",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnBlockParams.activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "activation: str = Field(default='relu6', description='Activation function')",
              "source": {
                "line": 43,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L43"
              },
              "summary": ""
            }
          ],
          "name": "TcnBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TcnBlockParams()",
          "source": {
            "line": 16,
            "path": "helia_edge/models/tcn_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L16"
          },
          "summary": "TCN block parameters"
        },
        {
          "description": "TCN parameters",
          "examples": [],
          "id": "helia_edge.models.tcn_params.TcnParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 64,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L64"
              },
              "summary": ""
            },
            {
              "description": "Model family",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['tcn'] = 'tcn'",
              "source": {
                "line": 66,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L66"
              },
              "summary": ""
            },
            {
              "description": "Input kernel size",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.input_kernel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_kernel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_kernel: int | tuple[int, int] | None = Field(default=None, description='Input kernel size')",
              "source": {
                "line": 67,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L67"
              },
              "summary": ""
            },
            {
              "description": "Input normalization type",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.input_norm",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_norm",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_norm: Literal['batch', 'layer'] | None = Field(default='layer', description='Input normalization type')",
              "source": {
                "line": 68,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L68"
              },
              "summary": ""
            },
            {
              "description": "Block type",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.block_type",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "block_type",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "block_type: Literal['lg', 'mb', 'sm'] = Field(default='mb', description='Block type')",
              "source": {
                "line": 69,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L69"
              },
              "summary": ""
            },
            {
              "description": "TCN blocks",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.blocks",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "blocks",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "blocks: list[TcnBlockParams] = Field(default_factory=list, description='TCN blocks')",
              "source": {
                "line": 70,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L70"
              },
              "summary": ""
            },
            {
              "description": "Output kernel size",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.output_kernel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_kernel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_kernel: int | tuple[int, int] = Field(default=3, description='Output kernel size')",
              "source": {
                "line": 71,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L71"
              },
              "summary": ""
            },
            {
              "description": "Include top",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.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": 72,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L72"
              },
              "summary": ""
            },
            {
              "description": "Classes of the output layer; required with include_top",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.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; required with include_top')",
              "source": {
                "line": 73,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L73"
              },
              "summary": ""
            },
            {
              "description": "Use logits",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.use_logits",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "use_logits",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "use_logits: bool = Field(default=True, description='Use logits')",
              "source": {
                "line": 76,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L76"
              },
              "summary": ""
            },
            {
              "description": "Output activation",
              "examples": [],
              "id": "helia_edge.models.tcn_params.TcnParams.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": 77,
                "path": "helia_edge/models/tcn_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L77"
              },
              "summary": ""
            }
          ],
          "name": "TcnParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "TcnParams()",
          "source": {
            "line": 48,
            "path": "helia_edge/models/tcn_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L48"
          },
          "summary": "TCN parameters"
        },
        {
          "description": "Four small SE4 blocks with 1/2/4/8 dilations and per-point linear output.\n\nThe input shape is supplied to ``build`` by the caller. At least eight channels retain the builder's\nSE squeeze path.",
          "examples": [],
          "id": "helia_edge.models.tcn_params.compact_tcn_params",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "compact_tcn_params",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "compact_tcn_params(*, filters: int = 8, num_classes: int | None = None) -> TcnParams",
          "source": {
            "line": 82,
            "path": "helia_edge/models/tcn_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tcn_params.py#L82"
          },
          "summary": "Four small SE4 blocks with 1/2/4/8 dilations and per-point linear output."
        }
      ]
    }
  ],
  "name": "helia_edge"
}