{
  "$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 Channel Layer API\n\nThis module provides classes to build random channel layers.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `RandomChannel` | Random channel |",
      "name": "random_channel",
      "path": "helia_edge.layers.preprocessing.random_channel",
      "submodules": [],
      "summary": "Random Channel Layer API",
      "symbols": [
        {
          "description": "Randomly picks a single channel from the input samples.\n\n\n\nBase class: [BaseAugmentation](/helia-edge/reference/api/helia_edge/layers/preprocessing/base_augmentation/#helia_edge.layers.preprocessing.base_augmentation.BaseAugmentation).\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_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_channel.RandomChannel",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_channel.RandomChannel.batchwise",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "batchwise",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "batchwise: bool = batchwise",
              "source": {
                "line": 29,
                "path": "helia_edge/layers/preprocessing/random_channel.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L29"
              },
              "summary": ""
            },
            {
              "description": "Generate random channel index.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_channel.RandomChannel.get_random_transformations",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_random_transformations",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_random_transformations(input_shape)",
              "source": {
                "line": 31,
                "path": "helia_edge/layers/preprocessing/random_channel.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L31"
              },
              "summary": "Generate random channel index."
            },
            {
              "description": "Augment samples",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_channel.RandomChannel.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs)",
              "source": {
                "line": 50,
                "path": "helia_edge/layers/preprocessing/random_channel.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L50"
              },
              "summary": "Augment samples"
            },
            {
              "description": "Augment a sample during training.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_channel.RandomChannel.augment_sample",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_sample",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_sample(inputs) -> keras.KerasTensor",
              "source": {
                "line": 62,
                "path": "helia_edge/layers/preprocessing/random_channel.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L62"
              },
              "summary": "Augment a sample during training."
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.random_channel.RandomChannel.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 68,
                "path": "helia_edge/layers/preprocessing/random_channel.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L68"
              },
              "summary": ""
            }
          ],
          "name": "RandomChannel",
          "params": [
            {
              "default": "False",
              "description": "If True, grabs same channel from all samples in batch.",
              "name": "batchwise",
              "type": "bool"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "RandomChannel(batchwise: bool = False, **kwargs={})",
          "source": {
            "line": 17,
            "path": "helia_edge/layers/preprocessing/random_channel.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/random_channel.py#L17"
          },
          "summary": "Randomly picks a single channel from the input samples."
        }
      ]
    }
  ],
  "name": "helia_edge"
}