{
  "$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": "# Rescaling Layer API\n\nThis module provides classes to build rescaling layers.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `Rescaling1D` | Rescaling 1D |\n| `Rescaling2D` | Rescaling 2D |",
      "name": "rescaling",
      "path": "helia_edge.layers.preprocessing.rescaling",
      "submodules": [],
      "summary": "Rescaling Layer API",
      "symbols": [
        {
          "description": "Rescale the input samples.\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), [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.rescaling.Rescaling1D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling1D.training_only",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "training_only",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "training_only = False",
              "source": {
                "line": 20,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L20"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling1D.scale",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scale",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scale: float = scale",
              "source": {
                "line": 30,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L30"
              },
              "summary": ""
            },
            {
              "description": "Rescale a batch of samples during training.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling1D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 32,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L32"
              },
              "summary": "Rescale a batch of samples during training."
            },
            {
              "description": "Serialize the configuration.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling1D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 37,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L37"
              },
              "summary": "Serialize the configuration."
            }
          ],
          "name": "Rescaling1D",
          "params": [
            {
              "description": "The scaling factor.",
              "name": "scale",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "Rescaling1D(scale: float, **kwargs={})",
          "source": {
            "line": 18,
            "path": "helia_edge/layers/preprocessing/rescaling.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L18"
          },
          "summary": "Rescale the input samples."
        },
        {
          "description": "Rescale the input samples.\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), [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.rescaling.Rescaling2D",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling2D.training_only",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "training_only",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "training_only = False",
              "source": {
                "line": 46,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L46"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling2D.scale",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "scale",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "scale: float = scale",
              "source": {
                "line": 56,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L56"
              },
              "summary": ""
            },
            {
              "description": "Rescale a batch of samples during training.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling2D.augment_samples",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "augment_samples",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "augment_samples(inputs) -> keras.KerasTensor",
              "source": {
                "line": 58,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L58"
              },
              "summary": "Rescale a batch of samples during training."
            },
            {
              "description": "Serialize the configuration.",
              "examples": [],
              "id": "helia_edge.layers.preprocessing.rescaling.Rescaling2D.get_config",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get_config()",
              "source": {
                "line": 63,
                "path": "helia_edge/layers/preprocessing/rescaling.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L63"
              },
              "summary": "Serialize the configuration."
            }
          ],
          "name": "Rescaling2D",
          "params": [
            {
              "description": "The scaling factor.",
              "name": "scale",
              "type": "float"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "Rescaling2D(scale: float, **kwargs={})",
          "source": {
            "line": 44,
            "path": "helia_edge/layers/preprocessing/rescaling.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/layers/preprocessing/rescaling.py#L44"
          },
          "summary": "Rescale the input samples."
        }
      ]
    }
  ],
  "name": "helia_edge"
}