{
  "$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": "# Random Gaussian Noise Layer API\n\nThis module provides classes to build random Gaussian noise layers.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `RandomGaussianNoise1D` | Random Gaussian noise 1D |",
      "name": "random_gaussian_noise",
      "path": "helia_edge.layers.preprocessing.random_gaussian_noise",
      "submodules": [],
      "summary": "Random Gaussian Noise Layer API",
      "symbols": [
        {
          "description": "Apply additive zero-centered Gaussian noise.\n\nExample:\n\n```python\n    x = np.sin(2*np.pi*10*np.arange(duration_size)/100)\n    lyr = RandomGaussianNoise1D(factor=0.1)\n    y = lyr(x)\n```\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).",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.random_gaussian_noise.RandomGaussianNoise1D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_gaussian_noise.RandomGaussianNoise1D.factor",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "factor",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "factor: tuple[float, float] = parse_factor(factor, min_value=0, max_value=None, param_name='factor')",
              "source": {
                "line": 37,
                "path": "helia_edge/layers/preprocessing/random_gaussian_noise.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_gaussian_noise.py#L37"
              },
              "summary": ""
            },
            {
              "description": "Generate noise tensor",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_gaussian_noise.RandomGaussianNoise1D.get_random_transformations",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_random_transformations",
              "params": [
                {
                  "description": "Input shape.",
                  "name": "input_shape",
                  "type": "tuple[int, ...]"
                }
              ],
              "raises": [],
              "returns": [
                {
                  "description": "Dictionary containing the noise tensor.",
                  "name": "dict",
                  "type": "dict"
                }
              ],
              "signature": "get_random_transformations(input_shape: tuple[int, ...]) -> dict",
              "source": {
                "line": 39,
                "path": "helia_edge/layers/preprocessing/random_gaussian_noise.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_gaussian_noise.py#L39"
              },
              "summary": "Generate noise tensor"
            },
            {
              "description": "Apply sampled noise; inference bypasses sampling and application.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_gaussian_noise.RandomGaussianNoise1D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 61,
                "path": "helia_edge/layers/preprocessing/random_gaussian_noise.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_gaussian_noise.py#L61"
              },
              "summary": "Apply sampled noise; inference bypasses sampling and application."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_gaussian_noise.RandomGaussianNoise1D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 65,
                "path": "helia_edge/layers/preprocessing/random_gaussian_noise.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_gaussian_noise.py#L65"
              },
              "summary": ""
            }
          ],
          "name": "RandomGaussianNoise1D",
          "params": [
            {
              "default": "0.1",
              "description": "Standard deviation of the Gaussian noise.",
              "name": "factor",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "RandomGaussianNoise1D(factor: float | tuple[float, float] = 0.1, **kwargs={})",
          "source": {
            "line": 17,
            "path": "helia_edge/layers/preprocessing/random_gaussian_noise.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_gaussian_noise.py#L17"
          },
          "summary": "Apply additive zero-centered Gaussian noise."
        }
      ]
    }
  ],
  "name": "helia_edge"
}