{
  "$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 resnet family; importable without Keras.",
      "name": "resnet_params",
      "path": "helia_edge.models.resnet_params",
      "submodules": [],
      "summary": "Typed parameters of the resnet family; importable without Keras.",
      "symbols": [
        {
          "description": "ResNet block parameters",
          "examples": [],
          "id": "helia_edge.models.resnet_params.ResNetBlockParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 21,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L21"
              },
              "summary": ""
            },
            {
              "description": "Number of filters",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.filters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "filters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "filters: int = Field(..., description='# filters')",
              "source": {
                "line": 23,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L23"
              },
              "summary": ""
            },
            {
              "description": "Layer depth",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.depth",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "depth",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "depth: int = Field(default=1, description='Layer depth')",
              "source": {
                "line": 24,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L24"
              },
              "summary": ""
            },
            {
              "description": "Kernel size",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.kernel_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "kernel_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "kernel_size: int | tuple[int, int] = Field(default=3, description='Kernel size')",
              "source": {
                "line": 25,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L25"
              },
              "summary": ""
            },
            {
              "description": "Stride size",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.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": 26,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L26"
              },
              "summary": ""
            },
            {
              "description": "Use bottleneck blocks",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.bottleneck",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "bottleneck",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "bottleneck: bool = Field(default=False, description='Use bottleneck blocks')",
              "source": {
                "line": 27,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L27"
              },
              "summary": ""
            },
            {
              "description": "Activation function",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetBlockParams.activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "activation: str = Field(default='relu6', description='Activation function')",
              "source": {
                "line": 28,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L28"
              },
              "summary": ""
            }
          ],
          "name": "ResNetBlockParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ResNetBlockParams()",
          "source": {
            "line": 8,
            "path": "helia_edge/models/resnet_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L8"
          },
          "summary": "ResNet block parameters"
        },
        {
          "description": "ResNet parameters",
          "examples": [],
          "id": "helia_edge.models.resnet_params.ResNetParams",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.model_config",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "model_config",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "model_config = ConfigDict(frozen=True, extra='forbid')",
              "source": {
                "line": 48,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L48"
              },
              "summary": ""
            },
            {
              "description": "Model family",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.family",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "family",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "family: Literal['resnet'] = 'resnet'",
              "source": {
                "line": 50,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L50"
              },
              "summary": ""
            },
            {
              "description": "ResNet blocks",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.blocks",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "blocks",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "blocks: list[ResNetBlockParams] = Field(default_factory=list, description='ResNet blocks')",
              "source": {
                "line": 51,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L51"
              },
              "summary": ""
            },
            {
              "description": "Input filters",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.input_filters",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_filters",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_filters: int = Field(default=0, description='Input filters')",
              "source": {
                "line": 52,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L52"
              },
              "summary": ""
            },
            {
              "description": "Input kernel size",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.input_kernel_size",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_kernel_size",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_kernel_size: int | tuple[int, int] = Field(default=3, description='Input kernel size')",
              "source": {
                "line": 53,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L53"
              },
              "summary": ""
            },
            {
              "description": "Input stride",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.input_strides",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_strides",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_strides: int | tuple[int, int] = Field(default=2, description='Input stride')",
              "source": {
                "line": 54,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L54"
              },
              "summary": ""
            },
            {
              "description": "Input activation",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.input_activation",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "input_activation",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "input_activation: str = Field(default='relu6', description='Input activation')",
              "source": {
                "line": 55,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L55"
              },
              "summary": ""
            },
            {
              "description": "Include top",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.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": 56,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L56"
              },
              "summary": ""
            },
            {
              "description": "Classes of the output layer",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.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": 57,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L57"
              },
              "summary": ""
            },
            {
              "description": "Output activation",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.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": 58,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L58"
              },
              "summary": ""
            },
            {
              "description": "Dropout rate",
              "examples": [],
              "id": "helia_edge.models.resnet_params.ResNetParams.dropout",
              "kind": "attribute",
              "language": "python",
              "members": [],
              "name": "dropout",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "dropout: float = Field(default=0.2, description='Dropout rate')",
              "source": {
                "line": 59,
                "path": "helia_edge/models/resnet_params.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L59"
              },
              "summary": ""
            }
          ],
          "name": "ResNetParams",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "ResNetParams()",
          "source": {
            "line": 31,
            "path": "helia_edge/models/resnet_params.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/models/resnet_params.py#L31"
          },
          "summary": "ResNet parameters"
        }
      ]
    }
  ],
  "name": "helia_edge"
}