{
  "$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": "# Activation Layers API\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `glu` | Gated linear unit layer |\n| `relu` | ReLU activation layer |\n| `swish` | Swish activation layer |\n| `relu6` | Hard ReLU activation layer |\n| `mish` | Mish activation layer |\n| `gelu` | GeLU activation layer |\n| `sigmoid` | Sigmoid activation layer |\n| `hard_sigmoid` | Hard sigmoid activation layer |\n\nPlease check [Keras Activations](https://keras.io/api/layers/activations/) for additional activations.",
      "name": "activations",
      "path": "helia_edge.layers.activations",
      "submodules": [],
      "summary": "Activation Layers API",
      "symbols": [
        {
          "description": "Gated linear unit layer",
          "examples": [],
          "id": "helia_edge.layers.activations.glu",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "glu",
          "params": [
            {
              "default": "-1",
              "description": "Dimension to split. Defaults to -1.",
              "name": "dim",
              "type": "int"
            },
            {
              "default": "False",
              "description": "Use hard sigmoid. Defaults to False.",
              "name": "hard",
              "type": "bool"
            },
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional GLU layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "glu(dim: int = -1, hard: bool = False, name: str | None = None) -> keras.Layer",
          "source": {
            "line": 20,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L20"
          },
          "summary": "Gated linear unit layer"
        },
        {
          "description": "ReLU activation layer w/ optional truncation to ReLU6",
          "examples": [],
          "id": "helia_edge.layers.activations.relu",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "relu",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            },
            {
              "default": "False",
              "description": "Truncate to ReLU6. Defaults to False.",
              "name": "truncated",
              "type": "bool"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional ReLU layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "relu(name: str | None = None, truncated: bool = False, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 44,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L44"
          },
          "summary": "ReLU activation layer w/ optional truncation to ReLU6"
        },
        {
          "description": "Swish activation layer w/ optional hard variant",
          "examples": [],
          "id": "helia_edge.layers.activations.swish",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "swish",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            },
            {
              "default": "False",
              "description": "Use hard swish. Defaults to False.",
              "name": "hard",
              "type": "bool"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional Swish layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "swish(name: str | None = None, hard: bool = False, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 60,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L60"
          },
          "summary": "Swish activation layer w/ optional hard variant"
        },
        {
          "description": "Hard ReLU activation layer",
          "examples": [],
          "id": "helia_edge.layers.activations.relu6",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "relu6",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional ReLU6 layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "relu6(name: str | None = None, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 75,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L75"
          },
          "summary": "Hard ReLU activation layer"
        },
        {
          "description": "Mish activation layer",
          "examples": [],
          "id": "helia_edge.layers.activations.mish",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "mish",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional Mish layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "mish(name: str | None = None, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 88,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L88"
          },
          "summary": "Mish activation layer"
        },
        {
          "description": "GeLU activation layer",
          "examples": [],
          "id": "helia_edge.layers.activations.gelu",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "gelu",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional GeLU layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "gelu(name: str | None = None, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 101,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L101"
          },
          "summary": "GeLU activation layer"
        },
        {
          "description": "Sigmoid activation layer",
          "examples": [],
          "id": "helia_edge.layers.activations.sigmoid",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "sigmoid",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            },
            {
              "default": "False",
              "description": "Use hard sigmoid. Defaults to False.",
              "name": "hard",
              "type": "bool"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional Sigmoid layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "sigmoid(name: str | None = None, hard: bool = False, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 114,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L114"
          },
          "summary": "Sigmoid activation layer"
        },
        {
          "description": "Hard sigmoid activation layer",
          "examples": [],
          "id": "helia_edge.layers.activations.hard_sigmoid",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "hard_sigmoid",
          "params": [
            {
              "default": "None",
              "description": "Layer name. Defaults to None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Layer: Functional Hard sigmoid layer",
              "type": "keras.Layer"
            }
          ],
          "signature": "hard_sigmoid(name: str | None = None, **kwargs={}) -> keras.Layer",
          "source": {
            "line": 129,
            "path": "helia_edge/layers/activations.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/activations.py#L129"
          },
          "summary": "Hard sigmoid activation layer"
        }
      ]
    }
  ],
  "name": "helia_edge"
}