{
  "$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": "Convolutional Layers API\n\nThis module provides classes to build convolutional layers.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `conv1d` | 1D convolutional layer using 2D convolutional layer |\n| `conv2d` | 2D convolutional layer |\n\nPlease refer to [Keras Convolutional Layers](https://keras.io/api/layers/convolution_layers/) for additional layers.",
      "name": "convolutional",
      "path": "helia_edge.layers.convolutional",
      "submodules": [],
      "summary": "Convolutional Layers API",
      "symbols": [
        {
          "description": "2D convolutional layer",
          "examples": [],
          "id": "helia_edge.layers.convolutional.conv2d",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "conv2d",
          "params": [
            {
              "description": "Number of filters",
              "name": "filters",
              "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": "'same'",
              "description": "Padding. Defaults to \"same\".",
              "name": "padding",
              "type": "str"
            },
            {
              "default": "False",
              "description": "Add bias. Defaults to False.",
              "name": "use_bias",
              "type": "bool"
            },
            {
              "default": "1",
              "description": "Number of groups. Defaults to 1.",
              "name": "groups",
              "type": "int"
            },
            {
              "default": "1",
              "description": "Dilation rate. Defaults to 1.",
              "name": "dilation",
              "type": "int"
            },
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional 2D conv layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "conv2d(\n    filters: int,\n    kernel_size: int | tuple[int, int] = 3,\n    strides: int | tuple[int, int] = 1,\n    padding: str = 'same',\n    use_bias: bool = False,\n    groups: int = 1,\n    dilation: int = 1,\n    name: str | None = None,\n) -> keras.Layer",
          "source": {
            "line": 16,
            "path": "helia_edge/layers/convolutional.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/convolutional.py#L16"
          },
          "summary": "2D convolutional layer"
        },
        {
          "description": "1D convolutional layer using 2D convolutional layer",
          "examples": [],
          "id": "helia_edge.layers.convolutional.conv1d",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "conv1d",
          "params": [
            {
              "description": "Number of filters",
              "name": "filters",
              "type": "int"
            },
            {
              "default": "3",
              "description": "Kernel size. Defaults to 3.",
              "name": "kernel_size",
              "type": "int"
            },
            {
              "default": "1",
              "description": "Stride length. Defaults to 1.",
              "name": "strides",
              "type": "int"
            },
            {
              "default": "'same'",
              "description": "Padding. Defaults to \"same\".",
              "name": "padding",
              "type": "str"
            },
            {
              "default": "False",
              "description": "Add bias. Defaults to False.",
              "name": "use_bias",
              "type": "bool"
            },
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional 1D conv layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "conv1d(\n    filters: int,\n    kernel_size: int = 3,\n    strides: int = 1,\n    padding: str = 'same',\n    use_bias: bool = False,\n    name: str | None = None,\n) -> keras.Layer",
          "source": {
            "line": 55,
            "path": "helia_edge/layers/convolutional.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/convolutional.py#L55"
          },
          "summary": "1D convolutional layer using 2D convolutional layer"
        }
      ]
    }
  ],
  "name": "helia_edge"
}