{
  "$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": "Typed parameters of the unet family; importable without Keras.",
      "name": "unet_params",
      "path": "helia_edge.models.unet_params",
      "submodules": [],
      "summary": "Typed parameters of the unet family; importable without Keras.",
      "symbols": [
        {
          "description": "UNet block parameters",
          "examples": [],
          "id": "helia_edge.models.unet_params.UNetBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 26,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L26"
              },
              "summary": ""
            },
            {
              "description": "Number of filters",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.filters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "filters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "filters: int = Field(..., description='# filters')",
              "source": {
                "line": 28,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L28"
              },
              "summary": ""
            },
            {
              "description": "Layer depth",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.depth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "depth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "depth: int = Field(default=1, description='Layer depth')",
              "source": {
                "line": 29,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L29"
              },
              "summary": ""
            },
            {
              "description": "Decoder depth",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.ddepth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "ddepth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "ddepth: int | None = Field(default=None, description='Decoder depth')",
              "source": {
                "line": 30,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L30"
              },
              "summary": ""
            },
            {
              "description": "Kernel size",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.kernel",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel: int | tuple[int, int] = Field(default=3, description='Kernel size')",
              "source": {
                "line": 31,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L31"
              },
              "summary": ""
            },
            {
              "description": "Pool size",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.pool",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "pool",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "pool: int | tuple[int, int] = Field(default=3, description='Pool size')",
              "source": {
                "line": 32,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L32"
              },
              "summary": ""
            },
            {
              "description": "Stride size",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.strides",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "strides",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "strides: int | tuple[int, int] = Field(default=1, description='Stride size')",
              "source": {
                "line": 33,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L33"
              },
              "summary": ""
            },
            {
              "description": "Add skip connection",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.skip",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "skip",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "skip: bool = Field(default=True, description='Add skip connection')",
              "source": {
                "line": 34,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L34"
              },
              "summary": ""
            },
            {
              "description": "Use seperable convs",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.seperable",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "seperable",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "seperable: bool = Field(default=False, description='Use seperable convs')",
              "source": {
                "line": 35,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L35"
              },
              "summary": ""
            },
            {
              "description": "Dropout rate",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.dropout",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dropout",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dropout: float | None = Field(default=None, description='Dropout rate')",
              "source": {
                "line": 36,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L36"
              },
              "summary": ""
            },
            {
              "description": "Normalization type",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.norm",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "norm",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "norm: Literal['batch', 'layer'] | None = Field(default='batch', description='Normalization type')",
              "source": {
                "line": 37,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L37"
              },
              "summary": ""
            },
            {
              "description": "Activation",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "activation: Literal['relu', 'relu6', 'leaky_relu', 'elu', 'selu'] = Field(default='relu6', description='Activation')",
              "source": {
                "line": 38,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L38"
              },
              "summary": ""
            },
            {
              "description": "Dilation factor",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetBlockParams.dilation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dilation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dilation: int | tuple[int, int] | None = Field(default=None, description='Dilation factor')",
              "source": {
                "line": 39,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L39"
              },
              "summary": ""
            }
          ],
          "name": "UNetBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "UNetBlockParams()",
          "source": {
            "line": 8,
            "path": "helia_edge/models/unet_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L8"
          },
          "summary": "UNet block parameters"
        },
        {
          "description": "UNet parameters",
          "examples": [],
          "id": "helia_edge.models.unet_params.UNetParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 56,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L56"
              },
              "summary": ""
            },
            {
              "description": "Model family",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['unet'] = 'unet'",
              "source": {
                "line": 58,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L58"
              },
              "summary": ""
            },
            {
              "description": "UNet blocks",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.blocks",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "blocks",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "blocks: list[UNetBlockParams] = Field(default_factory=list, description='UNet blocks')",
              "source": {
                "line": 59,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L59"
              },
              "summary": ""
            },
            {
              "description": "Include top",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.include_top",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "include_top",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "include_top: bool = Field(default=True, description='Include top')",
              "source": {
                "line": 60,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L60"
              },
              "summary": ""
            },
            {
              "description": "Classes of the output layer; required with include_top",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.num_classes",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "num_classes",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "num_classes: int | None = Field(default=None, gt=0, description='Classes of the output layer; required with include_top')",
              "source": {
                "line": 61,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L61"
              },
              "summary": ""
            },
            {
              "description": "Use logits",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.use_logits",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "use_logits",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "use_logits: bool = Field(default=True, description='Use logits')",
              "source": {
                "line": 64,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L64"
              },
              "summary": ""
            },
            {
              "description": "Output kernel size",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.output_kernel_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_kernel_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_kernel_size: int | tuple[int, int] = Field(default=3, description='Output kernel size')",
              "source": {
                "line": 65,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L65"
              },
              "summary": ""
            },
            {
              "description": "Output kernel stride",
              "examples": [],
              "id": "helia_edge.models.unet_params.UNetParams.output_kernel_stride",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_kernel_stride",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_kernel_stride: int | tuple[int, int] = Field(default=1, description='Output kernel stride')",
              "source": {
                "line": 66,
                "path": "helia_edge/models/unet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L66"
              },
              "summary": ""
            }
          ],
          "name": "UNetParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "UNetParams()",
          "source": {
            "line": 42,
            "path": "helia_edge/models/unet_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/unet_params.py#L42"
          },
          "summary": "UNet parameters"
        }
      ]
    }
  ],
  "name": "helia_edge"
}