{
  "$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": "# F-Score Metrics API\n\nThis module contains additional metrics for F-Score.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `MultiF1Score` | A wrapper around keras.metrics.F1Score to handle multi-dimensional data. |",
      "name": "fscore",
      "path": "helia_edge.metrics.fscore",
      "submodules": [],
      "summary": "F-Score Metrics API",
      "symbols": [
        {
          "description": "A wrapper around keras.metrics.F1Score to handle multi-dimensional data.\nThis class collapses down to 2D and treats last dimension as classes.\n\nExample:\n\n```python\nimport helia_edge as helia\n\nf1 = helia.metrics.MultiF1Score(average='macro')\ny_true = np.array([[0, 1, 0], [1, 0, 1]])\ny_pred = np.array([[0, 1, 0], [1, 0, 0]])\nf1.update_state(y_true, y_pred)\nprint(f1.result().numpy())\n```",
          "examples": [],
          "id": "helia_edge.metrics.fscore.MultiF1Score",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.metrics.fscore.MultiF1Score.update_state",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "update_state",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "update_state(y_true, y_pred, sample_weight=None)",
              "source": {
                "line": 34,
                "path": "helia_edge/metrics/fscore.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/fscore.py#L34"
              },
              "summary": ""
            }
          ],
          "name": "MultiF1Score",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "MultiF1Score()",
          "source": {
            "line": 16,
            "path": "helia_edge/metrics/fscore.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/metrics/fscore.py#L16"
          },
          "summary": "A wrapper around keras.metrics.F1Score to handle multi-dimensional data."
        }
      ]
    }
  ],
  "name": "helia_edge"
}