{
  "$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": "# ConvMixer\n\nFor more info, refer to the original paper [ConvMixer: Revisiting Convolution in Vision](https://arxiv.org/abs/2201.09792).\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `build` | ConvMixer model from ``ConvMixerParams`` |\n| `conv_mixer_block` | ConvMixer block |\n| `conv_mixer_layer` | ConvMixer layer |",
      "name": "convmixer",
      "path": "helia_edge.models.convmixer",
      "submodules": [],
      "summary": "ConvMixer",
      "symbols": [
        {
          "description": "ConvMixer block",
          "examples": [],
          "id": "helia_edge.models.convmixer.conv_mixer_block",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "conv_mixer_block",
          "params": [
            {
              "description": "Number of filters",
              "name": "filters",
              "type": "int"
            },
            {
              "description": "Kernel size",
              "name": "kernel_size",
              "type": "int"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "conv_mixer_block(filters: int, kernel_size: int) -> Callable[[keras.KerasTensor], keras.KerasTensor]",
          "source": {
            "line": 21,
            "path": "helia_edge/models/convmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/convmixer.py#L21"
          },
          "summary": "ConvMixer block"
        },
        {
          "description": "ConvMixer: https://openreview.net/pdf?id=TVHS5Y4dNvM.",
          "examples": [],
          "id": "helia_edge.models.convmixer.conv_mixer_layer",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "conv_mixer_layer",
          "params": [
            {
              "description": "Input tensor",
              "name": "x",
              "type": "keras.KerasTensor"
            },
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "ConvMixerParams"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.KerasTensor: Model output",
              "type": "keras.KerasTensor"
            }
          ],
          "signature": "conv_mixer_layer(x: keras.KerasTensor, params: ConvMixerParams) -> keras.KerasTensor",
          "source": {
            "line": 47,
            "path": "helia_edge/models/convmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/convmixer.py#L47"
          },
          "summary": "ConvMixer: https://openreview.net/pdf?id=TVHS5Y4dNvM."
        },
        {
          "description": "Build a ConvMixer model.",
          "examples": [],
          "id": "helia_edge.models.convmixer.build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "build",
          "params": [
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "ConvMixerParams"
            },
            {
              "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 ``convmixer`` unless ``name`` is given.",
              "type": "keras.Model"
            }
          ],
          "signature": "build(\n    params: ConvMixerParams,\n    input_shape: tuple[int | None, ...],\n    *,\n    batch_size: int | None = None,\n    name: str | None = None,\n) -> keras.Model",
          "source": {
            "line": 83,
            "path": "helia_edge/models/convmixer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/convmixer.py#L83"
          },
          "summary": "Build a ConvMixer model."
        }
      ]
    }
  ],
  "name": "helia_edge"
}