{
  "$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": "# Layer Normalization Layer API\n\nThis module provides classes to build layer normalization layers.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `LayerNormalization1D` | Layer normalization for 1D data |\n| `LayerNormalization2D` | Layer normalization for 2D data |",
      "name": "layer_normalization",
      "path": "helia_edge.layers.preprocessing.layer_normalization",
      "submodules": [],
      "summary": "Layer Normalization Layer API",
      "symbols": [
        {
          "description": "Apply Layer Normalization to the input.\n\n\n\nBase class: [BaseAugmentation1D](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation1D).\n\nInherited from [BaseAugmentation](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation): [augment_masks()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_masks), [augment_sample()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_sample), [augment_targets()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_targets), [batch_augment()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.batch_augment), [call()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.call), [get_random_transformations()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.get_random_transformations).",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization1D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization1D.training_only",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "training_only",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "training_only = False",
              "source": {
                "line": 20,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L20"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization1D.epsilon",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "epsilon",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "epsilon = epsilon",
              "source": {
                "line": 34,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L34"
              },
              "summary": ""
            },
            {
              "description": "Augment a batch of samples during training.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization1D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 36,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L36"
              },
              "summary": "Augment a batch of samples during training."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization1D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 47,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L47"
              },
              "summary": ""
            }
          ],
          "name": "LayerNormalization1D",
          "params": [
            {
              "default": "1e-06",
              "description": "Small value to avoid division by zero.",
              "name": "epsilon",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "LayerNormalization1D(epsilon: float = 1e-06, name=None, **kwargs={})",
          "source": {
            "line": 18,
            "path": "helia_edge/layers/preprocessing/layer_normalization.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L18"
          },
          "summary": "Apply Layer Normalization to the input."
        },
        {
          "description": "Apply Layer Normalization to the input.\n\n\n\nBase class: [BaseAugmentation2D](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation2D).\n\nInherited from [BaseAugmentation](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation): [augment_masks()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_masks), [augment_sample()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_sample), [augment_targets()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_targets), [batch_augment()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.batch_augment), [call()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.call), [get_random_transformations()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.get_random_transformations).",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization2D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization2D.training_only",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "training_only",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "training_only = False",
              "source": {
                "line": 53,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L53"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization2D.epsilon",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "epsilon",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "epsilon = epsilon",
              "source": {
                "line": 67,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L67"
              },
              "summary": ""
            },
            {
              "description": "Augment a batch of samples during training.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization2D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 69,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L69"
              },
              "summary": "Augment a batch of samples during training."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.layer_normalization.LayerNormalization2D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 80,
                "path": "helia_edge/layers/preprocessing/layer_normalization.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L80"
              },
              "summary": ""
            }
          ],
          "name": "LayerNormalization2D",
          "params": [
            {
              "default": "1e-06",
              "description": "Small value to avoid division by zero.",
              "name": "epsilon",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "LayerNormalization2D(epsilon: float = 1e-06, name=None, **kwargs={})",
          "source": {
            "line": 51,
            "path": "helia_edge/layers/preprocessing/layer_normalization.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/layer_normalization.py#L51"
          },
          "summary": "Apply Layer Normalization to the input."
        }
      ]
    }
  ],
  "name": "helia_edge"
}