{
  "$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": "# Composer Model API\n\nThis module provides utility functions to compose a sequential set of networks/layers.\n\nParameters are in ``helia_edge.models.composer_params``.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `build` | Composer model from ``ComposerParams`` |\n| `composer_layer` | Composes a sequential set of networks/layers |",
      "name": "composer",
      "path": "helia_edge.models.composer",
      "submodules": [],
      "summary": "Composer Model API",
      "symbols": [
        {
          "description": "",
          "examples": [],
          "id": "helia_edge.models.composer.logger",
          "kind": "attribute",
          "language": "python",
          "members": [],
          "name": "logger",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "logger = logging.getLogger(__name__)",
          "source": {
            "line": 25,
            "path": "helia_edge/models/composer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/composer.py#L25"
          },
          "summary": ""
        },
        {
          "description": "Composes a sequential set of networks/layers.\nUseful for adding custom layers to a pre-trained model (e.g. foundation).",
          "examples": [],
          "id": "helia_edge.models.composer.composer_layer",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "composer_layer",
          "params": [
            {
              "description": "Model input",
              "name": "x",
              "type": "keras.KerasTensor"
            },
            {
              "description": "Model parameters",
              "name": "params",
              "type": "ComposerParams"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.KerasTensor: Model output",
              "type": "keras.KerasTensor"
            }
          ],
          "signature": "composer_layer(x: keras.KerasTensor, params: ComposerParams) -> keras.KerasTensor",
          "source": {
            "line": 28,
            "path": "helia_edge/models/composer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/composer.py#L28"
          },
          "summary": "Composes a sequential set of networks/layers."
        },
        {
          "description": "Build a Composer model.",
          "examples": [],
          "id": "helia_edge.models.composer.build",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "build",
          "params": [
            {
              "description": "Model parameters.",
              "name": "params",
              "type": "ComposerParams"
            },
            {
              "description": "Input shape without the batch axis; None for a variable axis.",
              "name": "input_shape",
              "type": "tuple[int | None, ...]"
            },
            {
              "default": "None",
              "description": "Static batch size; None for a dynamic batch.",
              "name": "batch_size",
              "type": "int | None"
            },
            {
              "default": "None",
              "description": "Model name; the family when None.",
              "name": "name",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "keras.Model: The model, named ``composer`` unless ``name`` is given.",
              "type": "keras.Model"
            }
          ],
          "signature": "build(\n    params: ComposerParams,\n    input_shape: tuple[int | None, ...],\n    *,\n    batch_size: int | None = None,\n    name: str | None = None,\n) -> keras.Model",
          "source": {
            "line": 73,
            "path": "helia_edge/models/composer.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/composer.py#L73"
          },
          "summary": "Build a Composer model."
        }
      ]
    }
  ],
  "name": "helia_edge"
}