# helia_edge.plotting.roc

## ROC Plotting API

This module provides utility functions to plot ROC curves.

**Functions**

| Name | Description |
| --- | --- |
| `roc_auc_plot` | Generate ROC plot via matplotlib/seaborn |

## helia_edge.plotting.roc.roc_auc_plot

`function` · `python`

```python
roc_auc_plot(
    y_true: npt.NDArray,
    y_prob: npt.NDArray,
    labels: list[str],
    save_path: os.PathLike | None = None,
    **kwargs={},
) -> tuple[plt.Figure, plt.Axes] | None
```

Generate ROC plot via matplotlib/seaborn

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| y_true | npt.NDArray | Required | True y labels |
| y_prob | npt.NDArray | Required | Predicted y labels |
| labels | list[str] | Required | Label names |
| save_path | str \| None | None | Path to save plot. Defaults to None. |

**Returns**

| Name | Type | Description |
| --- | --- | --- |
|  | tuple[plt.Figure, plt.Axes] \| None | tuple[plt.Figure, plt.Axes] \| None: Figure and axes |

Source: `helia_edge/plotting/roc.py:23`