{
  "$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": "# TsMixer Model\n\n## Overview\n\nTsMixer is a fully MLP-based architecture for time series data.\n\nFor more info, refer to the original paper [TsMixer: An All-MLP Architecture for Time Series](https://arxiv.org/abs/2303.06053).\n\nParameters are in ``helia_edge.models.tsmixer_params``.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `build` | TsMixer model from ``TsMixerParams`` |\n| `ts_block` | Residual block of TsMixer |\n| `norm_layer` | Normalization layer |\n| `tsmixer_layer` | TsMixer layer |",
      "name": "tsmixer",
      "path": "helia_edge.models.tsmixer",
      "submodules": [],
      "summary": "TsMixer Model",
      "symbols": [
        {
          "description": "Normalization layer",
          "examples": [],
          "id": "helia_edge.models.tsmixer.norm_layer",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "norm_layer",
          "params": [
            {
              "description": "Normalization type",
              "name": "norm",
              "type": "str"
            },
            {
              "description": "Name",
              "name": "name",
              "type": "str"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "norm_layer(norm: str, name: str) -> keras.Layer",
          "source": {
            "line": 25,
            "path": "helia_edge/models/tsmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tsmixer.py#L25"
          },
          "summary": "Normalization layer"
        },
        {
          "description": "Residual block of TSMixer.",
          "examples": [],
          "id": "helia_edge.models.tsmixer.ts_block",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "ts_block",
          "params": [
            {
              "description": "Block parameters",
              "name": "params",
              "type": "TsBlockParams"
            },
            {
              "description": "Name",
              "name": "name",
              "type": "str"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "ts_block(params: TsMixerBlockParams, name: str) -> keras.Layer",
          "source": {
            "line": 54,
            "path": "helia_edge/models/tsmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tsmixer.py#L54"
          },
          "summary": "Residual block of TSMixer."
        },
        {
          "description": "TsMixer layer",
          "examples": [],
          "id": "helia_edge.models.tsmixer.tsmixer_layer",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "tsmixer_layer",
          "params": [
            {
              "description": "Input tensor",
              "name": "inputs",
              "type": "keras.KerasTensor"
            },
            {
              "description": "Model parameters",
              "name": "params",
              "type": "any"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.KerasTensor: Output tensor",
              "type": "keras.KerasTensor"
            }
          ],
          "signature": "tsmixer_layer(inputs: keras.KerasTensor, params: any) -> keras.KerasTensor",
          "source": {
            "line": 93,
            "path": "helia_edge/models/tsmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tsmixer.py#L93"
          },
          "summary": "TsMixer layer"
        },
        {
          "description": "Build a TsMixer model.",
          "examples": [],
          "id": "helia_edge.models.tsmixer.build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "build",
          "params": [
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "TsMixerParams"
            },
            {
              "description": "Input shape without the batch axis; None for a variable axis.",
              "name": "input_shape",
              "type": "tuple[int | None, ...]"
            },
            {
              "default": "None",
              "description": "Static batch size; None for a dynamic batch.",
              "name": "batch_size",
              "type": "int | None"
            },
            {
              "default": "None",
              "description": "Model name; the family when None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Model: The model, named ``tsmixer`` unless ``name`` is given.",
              "type": "keras.Model"
            }
          ],
          "signature": "build(\n    params: TsMixerParams,\n    input_shape: tuple[int | None, ...],\n    *,\n    batch_size: int | None = None,\n    name: str | None = None,\n) -> keras.Model",
          "source": {
            "line": 117,
            "path": "helia_edge/models/tsmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/tsmixer.py#L117"
          },
          "summary": "Build a TsMixer model."
        }
      ]
    }
  ],
  "name": "helia_edge"
}