{
  "$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 Sine Wave Layer API\n\nThis module provides classes to build random sine wave layers.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `RandomSineWave` | Random sine wave |",
      "name": "random_sine_wave",
      "path": "helia_edge.layers.preprocessing.random_sine_wave",
      "submodules": [],
      "summary": "Random Sine Wave Layer API",
      "symbols": [
        {
          "description": "Adds a sine wave 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_samples()](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation.augment_samples), [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_sine_wave.RandomSineWave",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.data_format",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "data_format",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "data_format: str",
              "source": {
                "line": 23,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L23"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.sample_rate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "sample_rate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "sample_rate: float = sample_rate",
              "source": {
                "line": 42,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L42"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.frequency",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "frequency",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "frequency: tuple[float, float] = parse_factor(frequency, min_value=0, max_value=sample_rate / 2, param_name='frequency')",
              "source": {
                "line": 43,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L43"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.amplitude",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "amplitude",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "amplitude: tuple[float, float] = parse_factor(amplitude, min_value=0, max_value=None, param_name='amplitude')",
              "source": {
                "line": 44,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L44"
              },
              "summary": ""
            },
            {
              "description": "Generate noise distortion tensor",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.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, int, int]) -> dict",
              "source": {
                "line": 46,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L46"
              },
              "summary": "Generate noise distortion tensor"
            },
            {
              "description": "Augment single sample with sine wave.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.augment_sample",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_sample",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_sample(inputs)",
              "source": {
                "line": 66,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L66"
              },
              "summary": "Augment single sample with sine wave."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_sine_wave.RandomSineWave.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 82,
                "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L82"
              },
              "summary": ""
            }
          ],
          "name": "RandomSineWave",
          "params": [
            {
              "default": "1",
              "description": "Sample rate of the input.",
              "name": "sample_rate",
              "type": "float"
            },
            {
              "default": "100",
              "description": "Frequency of the wave in Hz. If tuple, frequency is randomly picked between the values.",
              "name": "frequency",
              "type": "float | tuple[float, float]"
            },
            {
              "default": "0.1",
              "description": "Amplitude of the wave. If tuple, amplitude is randomly picked between the values.",
              "name": "amplitude",
              "type": "float | tuple[float, float]"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "RandomSineWave(\n    sample_rate: float = 1,\n    frequency: float | tuple[float, float] = 100,\n    amplitude: float | tuple[float, float] = 0.1,\n    **kwargs={},\n)",
          "source": {
            "line": 18,
            "path": "helia_edge/layers/preprocessing/random_sine_wave.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_sine_wave.py#L18"
          },
          "summary": "Adds a sine wave to the input."
        }
      ]
    }
  ],
  "name": "helia_edge"
}