{
  "$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": "Signal-only occlusion with explicit half-open intervals and owned RNG.",
      "name": "random_cutout",
      "path": "helia_edge.layers.preprocessing.random_cutout",
      "submodules": [],
      "summary": "Signal-only occlusion with explicit half-open intervals and owned RNG.",
      "symbols": [
        {
          "description": "Sample one interval per example; returned mask broadcasts over channels.",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.random_cutout.interval_mask",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "interval_mask",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "interval_mask(layer, shape, axis, minimum, maximum)",
          "source": {
            "line": 9,
            "path": "helia_edge/layers/preprocessing/random_cutout.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L9"
          },
          "summary": "Sample one interval per example; returned mask broadcasts over channels."
        },
        {
          "description": "Replace random temporal intervals in each example during training.\n\nRegions share their positions across channels. Targets and masks remain\nunchanged; only signal values are occluded. Overlapping regions are allowed.\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_cutout.RandomCutout1D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout1D.get_random_transformations",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_random_transformations",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_random_transformations(input_shape)",
              "source": {
                "line": 89,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L89"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout1D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs)",
              "source": {
                "line": 92,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L92"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout1D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 98,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L98"
              },
              "summary": ""
            }
          ],
          "name": "RandomCutout1D",
          "params": [
            {
              "default": "0.1",
              "description": "Fractional size bounds in [0, 1] for each spatial axis. A scalar\nsets the upper bound with a zero lower bound; a pair sets both bounds.",
              "name": "factor",
              "type": "float | tuple[float, float]"
            },
            {
              "default": "1",
              "description": "Nonnegative number of regions sampled per example.",
              "name": "cutouts",
              "type": "int"
            },
            {
              "default": "'constant'",
              "description": "\"constant\" for a fixed value or \"normal\" for Gaussian noise.",
              "name": "fill_mode",
              "type": "str"
            },
            {
              "default": "0.0",
              "description": "Constant fill value, or the nonnegative standard deviation\nof zero-mean Gaussian noise when fill_mode is \"normal\".",
              "name": "fill_value",
              "type": "float"
            },
            {
              "default": "{}",
              "description": "Base augmentation options, including seed and data_format.",
              "name": "**kwargs",
              "type": "Any"
            }
          ],
          "raises": [
            {
              "description": "Size bounds, region count, fill mode or noise deviation\nviolate these constraints.",
              "type": "ValueError"
            }
          ],
          "returns": [],
          "signature": "RandomCutout1D(factor=0.1, cutouts=1, fill_mode='constant', fill_value=0.0, **kwargs={})",
          "source": {
            "line": 64,
            "path": "helia_edge/layers/preprocessing/random_cutout.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L64"
          },
          "summary": "Replace random temporal intervals in each example during training."
        },
        {
          "description": "Replace random rectangular regions in each example during training.\n\nRegions share their positions across channels. Targets and masks remain\nunchanged; only signal values are occluded. Overlapping regions are allowed.\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).",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout2D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout2D.get_random_transformations",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_random_transformations",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_random_transformations(input_shape)",
              "source": {
                "line": 127,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L127"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout2D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs)",
              "source": {
                "line": 130,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L130"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_cutout.RandomCutout2D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 136,
                "path": "helia_edge/layers/preprocessing/random_cutout.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L136"
              },
              "summary": ""
            }
          ],
          "name": "RandomCutout2D",
          "params": [
            {
              "default": "0.1",
              "description": "Fractional size bounds in [0, 1] for each spatial axis. A scalar\nsets the upper bound with a zero lower bound; a pair sets both bounds.",
              "name": "factor",
              "type": "float | tuple[float, float]"
            },
            {
              "default": "1",
              "description": "Nonnegative number of regions sampled per example.",
              "name": "cutouts",
              "type": "int"
            },
            {
              "default": "'constant'",
              "description": "\"constant\" for a fixed value or \"normal\" for Gaussian noise.",
              "name": "fill_mode",
              "type": "str"
            },
            {
              "default": "0.0",
              "description": "Constant fill value, or the nonnegative standard deviation\nof zero-mean Gaussian noise when fill_mode is \"normal\".",
              "name": "fill_value",
              "type": "float"
            },
            {
              "default": "{}",
              "description": "Base augmentation options, including seed and data_format.",
              "name": "**kwargs",
              "type": "Any"
            }
          ],
          "raises": [
            {
              "description": "Size bounds, region count, fill mode or noise deviation\nviolate these constraints.",
              "type": "ValueError"
            }
          ],
          "returns": [],
          "signature": "RandomCutout2D(factor=0.1, cutouts=1, fill_mode='constant', fill_value=0.0, **kwargs={})",
          "source": {
            "line": 102,
            "path": "helia_edge/layers/preprocessing/random_cutout.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_cutout.py#L102"
          },
          "summary": "Replace random rectangular regions in each example during training."
        }
      ]
    }
  ],
  "name": "helia_edge"
}