{
  "$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": "# RegNet Model API\n\nThis module provides utility functions to generate RegNet models.\n\nFore more information, please refer to the following paper: https://arxiv.org/abs/2101.00590\n\nParameters are in ``helia_edge.models.regnet_params``.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `build` | RegNet model from ``RegNetParams`` |\n| `regnet_core` | RegNet core |\n| `regnet_layer` | Generate RegNet model |",
      "name": "regnet",
      "path": "helia_edge.models.regnet",
      "submodules": [],
      "summary": "RegNet Model API",
      "symbols": [
        {
          "description": "RegNet Y-Block",
          "examples": [],
          "id": "helia_edge.models.regnet.yblock",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "yblock",
          "params": [
            {
              "default": "0",
              "description": "Number of output filters. Defaults to 0.",
              "name": "output_filters",
              "type": "int"
            },
            {
              "default": "0",
              "description": "Group width. Defaults to 0.",
              "name": "group_width",
              "type": "int"
            },
            {
              "default": "3",
              "description": "Kernel size. Defaults to 3.",
              "name": "kernel_size",
              "type": "int | tuple[int, int]"
            },
            {
              "default": "1",
              "description": "Stride length. Defaults to 1.",
              "name": "strides",
              "type": "int | tuple[int, int]"
            },
            {
              "default": "4",
              "description": "SE ratio. Defaults to 4.",
              "name": "se_ratio",
              "type": "float"
            },
            {
              "default": "'relu6'",
              "description": "Activation function. Defaults to \"relu6\".",
              "name": "activation",
              "type": "str"
            },
            {
              "default": "None",
              "description": "Block name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "Callable[[keras.KerasTensor], keras.KerasTensor]: Functional layer",
              "type": "Callable[[keras.KerasTensor], keras.KerasTensor]"
            }
          ],
          "signature": "yblock(\n    output_filters: int = 0,\n    group_width: int = 0,\n    kernel_size: int | tuple[int, int] = 3,\n    strides: int | tuple[int, int] = 1,\n    se_ratio: float = 4,\n    activation: str = 'relu6',\n    name: str | None = None,\n) -> Callable[[keras.KerasTensor], keras.KerasTensor]",
          "source": {
            "line": 28,
            "path": "helia_edge/models/regnet.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/regnet.py#L28"
          },
          "summary": "RegNet Y-Block"
        },
        {
          "description": "RegNet X-Block",
          "examples": [],
          "id": "helia_edge.models.regnet.zblock",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "zblock",
          "params": [
            {
              "default": "0",
              "description": "Number of output filters. Defaults to 0.",
              "name": "output_filters",
              "type": "int"
            },
            {
              "default": "0",
              "description": "Group width. Defaults to 0.",
              "name": "group_width",
              "type": "int"
            },
            {
              "default": "3",
              "description": "Kernel size. Defaults to 3.",
              "name": "kernel_size",
              "type": "int | tuple[int, int]"
            },
            {
              "default": "1",
              "description": "Stride length. Defaults to 1.",
              "name": "strides",
              "type": "int | tuple[int, int]"
            },
            {
              "default": "4",
              "description": "SE ratio. Defaults to 4.",
              "name": "se_ratio",
              "type": "float"
            },
            {
              "default": "'relu6'",
              "description": "Activation function. Defaults to \"relu6\".",
              "name": "activation",
              "type": "str"
            },
            {
              "default": "None",
              "description": "Block name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "Callable[[keras.KerasTensor], keras.KerasTensor]: Functional layer",
              "type": "Callable[[keras.KerasTensor], keras.KerasTensor]"
            }
          ],
          "signature": "zblock(\n    output_filters: int = 0,\n    group_width: int = 0,\n    kernel_size: int | tuple[int, int] = 3,\n    strides: int | tuple[int, int] = 1,\n    se_ratio: float = 4,\n    activation: str = 'relu6',\n    name: str | None = None,\n) -> Callable[[keras.KerasTensor], keras.KerasTensor]",
          "source": {
            "line": 94,
            "path": "helia_edge/models/regnet.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/regnet.py#L94"
          },
          "summary": "RegNet X-Block"
        },
        {
          "description": "RegNet core",
          "examples": [],
          "id": "helia_edge.models.regnet.regnet_core",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "regnet_core",
          "params": [
            {
              "description": "Block params",
              "name": "blocks",
              "type": "list[RegNetBlockParam]"
            },
            {
              "default": "'y'",
              "description": "Block style. Defaults to 'y'.",
              "name": "block_style",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "Callable[[keras.KerasTensor], keras.KerasTensor]: Core",
              "type": "Callable[[keras.KerasTensor], keras.KerasTensor]"
            }
          ],
          "signature": "regnet_core(\n    blocks: list[RegNetBlockParam],\n    block_style: Literal['y', 'z'] = 'y',\n) -> Callable[[keras.KerasTensor], keras.KerasTensor]",
          "source": {
            "line": 158,
            "path": "helia_edge/models/regnet.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/regnet.py#L158"
          },
          "summary": "RegNet core"
        },
        {
          "description": "Create RegNet TF functional model",
          "examples": [],
          "id": "helia_edge.models.regnet.regnet_layer",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "regnet_layer",
          "params": [
            {
              "description": "Input tensor",
              "name": "x",
              "type": "keras.KerasTensor"
            },
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "RegNetParams"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.KerasTensor: Output tensor",
              "type": "keras.KerasTensor"
            }
          ],
          "signature": "regnet_layer(x: keras.KerasTensor, params: RegNetParams) -> keras.KerasTensor",
          "source": {
            "line": 194,
            "path": "helia_edge/models/regnet.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/regnet.py#L194"
          },
          "summary": "Create RegNet TF functional model"
        },
        {
          "description": "Build a RegNet model.",
          "examples": [],
          "id": "helia_edge.models.regnet.build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "build",
          "params": [
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "RegNetParams"
            },
            {
              "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 ``regnet`` unless ``name`` is given.",
              "type": "keras.Model"
            }
          ],
          "signature": "build(\n    params: RegNetParams,\n    input_shape: tuple[int | None, ...],\n    *,\n    batch_size: int | None = None,\n    name: str | None = None,\n) -> keras.Model",
          "source": {
            "line": 248,
            "path": "helia_edge/models/regnet.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/regnet.py#L248"
          },
          "summary": "Build a RegNet model."
        }
      ]
    }
  ],
  "name": "helia_edge"
}