{
  "$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": "Serializable composition of preprocessing and training-only augmentation.",
      "name": "augmentation_pipeline",
      "path": "helia_edge.layers.preprocessing.augmentation_pipeline",
      "submodules": [],
      "summary": "Serializable composition of preprocessing and training-only augmentation.",
      "symbols": [
        {
          "description": "Apply layers in order to a tensor or structured sample.\n\nEach child receives the preceding child's output and the training flag.\nLayers must accept ``training`` and, when supplied, ``transformations``.\nCalling with transformations requires one entry per layer; use None for\na child that should sample its own parameters.",
          "examples": [],
          "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline.layers",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "layers",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "layers = layers",
              "source": {
                "line": 30,
                "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L30"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline.force_training",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "force_training",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "force_training = force_training",
              "source": {
                "line": 31,
                "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L31"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline.call",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "call",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "call(inputs, training=None, transformations=None)",
              "source": {
                "line": 33,
                "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L33"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 42,
                "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L42"
              },
              "summary": ""
            },
            {
              "description": "`classmethod`",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.augmentation_pipeline.AugmentationPipeline.from_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "from_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "from_config(config)",
              "source": {
                "line": 49,
                "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L49"
              },
              "summary": ""
            }
          ],
          "name": "AugmentationPipeline",
          "params": [
            {
              "description": "Ordered layers to apply. The layer objects are retained.",
              "name": "layers",
              "type": "list[keras.Layer]"
            },
            {
              "default": "None",
              "description": "Optional Keras layer name.",
              "name": "name",
              "type": "str | None"
            },
            {
              "default": "False",
              "description": "Pass training=True to every child, including at inference.",
              "name": "force_training",
              "type": "bool"
            },
            {
              "default": "{}",
              "description": "Additional Keras Layer arguments.",
              "name": "**kwargs",
              "type": "Any"
            }
          ],
          "raises": [
            {
              "description": "The supplied transformations count differs from the layer count.",
              "type": "ValueError"
            }
          ],
          "returns": [],
          "signature": "AugmentationPipeline(layers: list[keras.Layer], name=None, force_training=False, **kwargs={})",
          "source": {
            "line": 8,
            "path": "helia_edge/layers/preprocessing/augmentation_pipeline.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/augmentation_pipeline.py#L8"
          },
          "summary": "Apply layers in order to a tensor or structured sample."
        }
      ]
    }
  ],
  "name": "helia_edge"
}