{
  "$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": "# ROC Plotting API\n\nThis module provides utility functions to plot ROC curves.\n\n**Functions**\n\n| Name | Description |\n| --- | --- |\n| `roc_auc_plot` | Generate ROC plot via matplotlib/seaborn |",
      "name": "roc",
      "path": "helia_edge.plotting.roc",
      "submodules": [],
      "summary": "ROC Plotting API",
      "symbols": [
        {
          "description": "Generate ROC plot via matplotlib/seaborn",
          "examples": [],
          "id": "helia_edge.plotting.roc.roc_auc_plot",
          "kind": "function",
          "language": "python",
          "members": [],
          "name": "roc_auc_plot",
          "params": [
            {
              "description": "True y labels",
              "name": "y_true",
              "type": "npt.NDArray"
            },
            {
              "description": "Predicted y labels",
              "name": "y_prob",
              "type": "npt.NDArray"
            },
            {
              "description": "Label names",
              "name": "labels",
              "type": "list[str]"
            },
            {
              "default": "None",
              "description": "Path to save plot. Defaults to None.",
              "name": "save_path",
              "type": "str | None"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "tuple[plt.Figure, plt.Axes] | None: Figure and axes",
              "type": "tuple[plt.Figure, plt.Axes] | None"
            }
          ],
          "signature": "roc_auc_plot(\n    y_true: npt.NDArray,\n    y_prob: npt.NDArray,\n    labels: list[str],\n    save_path: os.PathLike | None = None,\n    **kwargs={},\n) -> tuple[plt.Figure, plt.Axes] | None",
          "source": {
            "line": 23,
            "path": "helia_edge/plotting/roc.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/plotting/roc.py#L23"
          },
          "summary": "Generate ROC plot via matplotlib/seaborn"
        }
      ]
    }
  ],
  "name": "helia_edge"
}