{
  "$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 metaformer family; importable without Keras.",
      "name": "metaformer_params",
      "path": "helia_edge.models.metaformer_params",
      "submodules": [],
      "summary": "Typed parameters of the metaformer family; importable without Keras.",
      "symbols": [
        {
          "description": "Name and arguments",
          "examples": [],
          "id": "helia_edge.models.metaformer_params.NameArgs",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.NameArgs.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 17,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L17"
              },
              "summary": ""
            },
            {
              "description": "Name",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.NameArgs.name",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "name",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "name: str = Field(default='conv', description='Name')",
              "source": {
                "line": 19,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L19"
              },
              "summary": ""
            },
            {
              "description": "Arguments",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.NameArgs.args",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "args",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "args: dict = Field(default_factory=dict, description='Arguments')",
              "source": {
                "line": 20,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L20"
              },
              "summary": ""
            }
          ],
          "name": "NameArgs",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "NameArgs()",
          "source": {
            "line": 8,
            "path": "helia_edge/models/metaformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L8"
          },
          "summary": "Name and arguments"
        },
        {
          "description": "MetaFormer block parameters",
          "examples": [],
          "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 34,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L34"
              },
              "summary": ""
            },
            {
              "description": "Number of layers",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams.layers",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "layers",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "layers: int = Field(default=2, description='Number of layers')",
              "source": {
                "line": 36,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L36"
              },
              "summary": ""
            },
            {
              "description": "Patch embedding",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams.patch_embed",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "patch_embed",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "patch_embed: dict = Field(default_factory=dict, description='Patch embedding')",
              "source": {
                "line": 37,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L37"
              },
              "summary": ""
            },
            {
              "description": "Token mixer",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams.token_mixer",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "token_mixer",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "token_mixer: NameArgs = Field(default_factory=dict, description='Token mixer')",
              "source": {
                "line": 38,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L38"
              },
              "summary": ""
            },
            {
              "description": "Channel mixer",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerBlockParams.channel_mixer",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "channel_mixer",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "channel_mixer: NameArgs = Field(default_factory=dict, description='Channel mixer')",
              "source": {
                "line": 39,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L39"
              },
              "summary": ""
            }
          ],
          "name": "MetaFormerBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MetaFormerBlockParams()",
          "source": {
            "line": 23,
            "path": "helia_edge/models/metaformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L23"
          },
          "summary": "MetaFormer block parameters"
        },
        {
          "description": "MetaFormer parameters",
          "examples": [],
          "id": "helia_edge.models.metaformer_params.MetaFormerParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 57,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L57"
              },
              "summary": ""
            },
            {
              "description": "Model family",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['metaformer'] = 'metaformer'",
              "source": {
                "line": 59,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L59"
              },
              "summary": ""
            },
            {
              "description": "MetaFormer blocks",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.blocks",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "blocks",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "blocks: list[MetaFormerBlockParams] = Field(default_factory=list, description='MetaFormer blocks')",
              "source": {
                "line": 60,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L60"
              },
              "summary": ""
            },
            {
              "description": "Output filters",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.output_filters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_filters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_filters: int = Field(default=0, description='Output filters')",
              "source": {
                "line": 61,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L61"
              },
              "summary": ""
            },
            {
              "description": "Output activation",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.output_activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "output_activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "output_activation: str | None = Field(default=None, description='Output activation')",
              "source": {
                "line": 62,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L62"
              },
              "summary": ""
            },
            {
              "description": "Include top",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.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": 63,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L63"
              },
              "summary": ""
            },
            {
              "description": "Classes of the output layer",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.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')",
              "source": {
                "line": 64,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L64"
              },
              "summary": ""
            },
            {
              "description": "Dropout rate",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.dropout",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dropout",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dropout: float = Field(default=0.2, description='Dropout rate')",
              "source": {
                "line": 65,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L65"
              },
              "summary": ""
            },
            {
              "description": "Drop connect rate",
              "examples": [],
              "id": "helia_edge.models.metaformer_params.MetaFormerParams.drop_connect_rate",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "drop_connect_rate",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "drop_connect_rate: float = Field(default=0.2, description='Drop connect rate')",
              "source": {
                "line": 66,
                "path": "helia_edge/models/metaformer_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L66"
              },
              "summary": ""
            }
          ],
          "name": "MetaFormerParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MetaFormerParams()",
          "source": {
            "line": 42,
            "path": "helia_edge/models/metaformer_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/metaformer_params.py#L42"
          },
          "summary": "MetaFormer parameters"
        }
      ]
    }
  ],
  "name": "helia_edge"
}