{
  "$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": "Fixed mean/variance normalization for two-dimensional signals.",
      "name": "normalization_2d",
      "path": "helia_edge.layers.preprocessing.normalization_2d",
      "submodules": [],
      "summary": "Fixed mean/variance normalization for two-dimensional signals.",
      "symbols": [
        {
          "description": "Apply fixed mean/variance normalization to 2D inputs.\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.normalization_2d.Normalization2D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.training_only",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "training_only",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "training_only = False",
              "source": {
                "line": 11,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L11"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.mean",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "mean",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "mean: float | list[float] | tuple[float, ...] = mean",
              "source": {
                "line": 33,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L33"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.variance",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "variance",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "variance: float | list[float] | tuple[float, ...] = variance",
              "source": {
                "line": 34,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L34"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.epsilon",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "epsilon",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "epsilon: float = epsilon",
              "source": {
                "line": 35,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L35"
              },
              "summary": ""
            },
            {
              "description": "Normalize a batch of samples.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 37,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L37"
              },
              "summary": "Normalize a batch of samples."
            },
            {
              "description": "Serialize the configuration.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.normalization_2d.Normalization2D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 48,
                "path": "helia_edge/layers/preprocessing/normalization_2d.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L48"
              },
              "summary": "Serialize the configuration."
            }
          ],
          "name": "Normalization2D",
          "params": [
            {
              "description": "Mean value(s) used for normalization.",
              "name": "mean",
              "type": "float | list[float] | tuple[float, ...]"
            },
            {
              "description": "Variance value(s) used for normalization.",
              "name": "variance",
              "type": "float | list[float] | tuple[float, ...]"
            },
            {
              "default": "1e-06",
              "description": "Small value to avoid division by zero.",
              "name": "epsilon",
              "type": "float"
            },
            {
              "default": "None",
              "description": "Layer name.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "Normalization2D(\n    mean: float | list[float] | tuple[float, ...],\n    variance: float | list[float] | tuple[float, ...],\n    epsilon: float = 1e-06,\n    name: str | None = None,\n    **kwargs={},\n)",
          "source": {
            "line": 9,
            "path": "helia_edge/layers/preprocessing/normalization_2d.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/normalization_2d.py#L9"
          },
          "summary": "Apply fixed mean/variance normalization to 2D inputs."
        }
      ]
    }
  ],
  "name": "helia_edge"
}