{
  "$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": "Repeated batchwise random choices sharing the standard training contract.",
      "name": "random_augmentation_pipeline",
      "path": "helia_edge.layers.preprocessing.random_augmentation_pipeline",
      "submodules": [],
      "summary": "Repeated batchwise random choices sharing the standard training contract.",
      "symbols": [
        {
          "description": "Apply repeated random layer choices to an entire batch.\n\nEach round samples one layer for the batch, with replacement, and applies\nit with probability rate. Inference is unchanged unless force_training is\nenabled. Candidate layers must produce compatible shapes and structures.\n\n\n\nBase class: [RandomChoice](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice).\n\nInherited from [RandomChoice](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice): [build()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice.build), [from_config()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice.from_config).\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_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), [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.random_augmentation_pipeline.RandomAugmentation1DPipeline",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.augmentations_per_sample",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "augmentations_per_sample",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augmentations_per_sample = augmentations_per_sample",
              "source": {
                "line": 50,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L50"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.rate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "rate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "rate = rate",
              "source": {
                "line": 51,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L51"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.force_training",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "force_training",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "force_training = force_training",
              "source": {
                "line": 52,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L52"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.batch_augment",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "batch_augment",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "batch_augment(inputs, transformations=None)",
              "source": {
                "line": 54,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L54"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.call",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "call",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "call(inputs, training=None, transformations=None)",
              "source": {
                "line": 70,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L70"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 73,
                "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L73"
              },
              "summary": ""
            }
          ],
          "name": "RandomAugmentation1DPipeline",
          "params": [
            {
              "description": "Nonempty list of candidate augmentation layers.",
              "name": "layers",
              "type": "list[keras.Layer]"
            },
            {
              "default": "1",
              "description": "Number of batchwise selection rounds. Zero\nleaves the input unchanged.",
              "name": "augmentations_per_sample",
              "type": "int"
            },
            {
              "default": "1.0",
              "description": "Probability of applying each round, between zero and one.",
              "name": "rate",
              "type": "float"
            },
            {
              "default": "True",
              "description": "Must be True; per-example layer selection is unsupported.",
              "name": "batchwise",
              "type": "bool"
            },
            {
              "default": "False",
              "description": "Apply augmentation even when training is False or None.",
              "name": "force_training",
              "type": "bool"
            },
            {
              "default": "{}",
              "description": "Base augmentation options, including seed and data_format.",
              "name": "**kwargs",
              "type": "Any"
            }
          ],
          "raises": [
            {
              "description": "The layer list is empty, the round count is not a nonnegative\ninteger, rate is outside [0, 1], or explicit transformations are used.",
              "type": "ValueError"
            },
            {
              "description": "batchwise is False.",
              "type": "NotImplementedError"
            }
          ],
          "returns": [],
          "signature": "RandomAugmentation1DPipeline(\n    layers: list[keras.Layer],\n    augmentations_per_sample: int = 1,\n    rate: float = 1.0,\n    batchwise: bool = True,\n    force_training: bool = False,\n    **kwargs={},\n)",
          "source": {
            "line": 9,
            "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L9"
          },
          "summary": "Apply repeated random layer choices to an entire batch."
        },
        {
          "description": "The same batchwise composition contract for image transforms.\n\n\n\nBase class: [RandomAugmentation1DPipeline](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_augmentation_pipeline/#helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline).\n\nInherited from [RandomAugmentation1DPipeline](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_augmentation_pipeline/#helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline): [batch_augment()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_augmentation_pipeline/#helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.batch_augment), [call()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_augmentation_pipeline/#helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.call), [get_config()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_augmentation_pipeline/#helia_edge.layers.preprocessing.random_augmentation_pipeline.RandomAugmentation1DPipeline.get_config).\n\nInherited from [RandomChoice](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice): [build()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice.build), [from_config()](/helia-edge/reference/api/helia_edge/layers/preprocessing/random_choice/#helia_edge.layers.preprocessing.random_choice.RandomChoice.from_config).\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_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), [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.random_augmentation_pipeline.RandomAugmentation2DPipeline",
          "kind": "class",
          "language": "python",
          "members": [],
          "name": "RandomAugmentation2DPipeline",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "RandomAugmentation2DPipeline(\n    layers: list[keras.Layer],\n    augmentations_per_sample: int = 1,\n    rate: float = 1.0,\n    batchwise: bool = True,\n    force_training: bool = False,\n    **kwargs={},\n)",
          "source": {
            "line": 82,
            "path": "helia_edge/layers/preprocessing/random_augmentation_pipeline.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_augmentation_pipeline.py#L82"
          },
          "summary": "The same batchwise composition contract for image transforms."
        }
      ]
    }
  ],
  "name": "helia_edge"
}