aidevelopementtoolkit.logging_utils.plotly_utils

plot_heatmap(data: np.ndarray, title: str, xaxis_title: str, yaxis_title: str, path: Optional[str] = None, xticklabels: Optional[List[str]] = None, yticklabels: Optional[List[str]] = None, zrange: Optional[Tuple[float, float]] = None) -> go.Figure

Plot a matrix as an annotated heatmap.

Parameters:
  • data (ndarray) –

    Matrix to plot with shape (N, M).

  • title (str) –

    Plot title.

  • xaxis_title (str) –

    Title for the X-axis.

  • yaxis_title (str) –

    Title for the Y-axis.

  • path (str, default: None ) –

    Path where the figure will be saved. If an MLFlow run is started, the figure is logged in the given path.

  • xticklabels (Optional[List[str]], default: None ) –

    Labels for the X-axis ticks. Must have length equal to the number of columns in data. If None, column indices are used.

  • yticklabels (Optional[List[str]], default: None ) –

    Labels for the Y-axis ticks. Must have length equal to the number of rows in data. If None, row indices are used.

  • zrange (Optional[Tuple[float, float]], default: None ) –

    Tuple specifying the minimum and maximum values for the color scale. When None the minimum and maximum values of data are used.

Returns:
  • Figure

    Matrix figure.

Examples:

Create and save a heatmap from a NumPy matrix:

>>> import numpy as np
>>> matrix = np.array([
...     [1.0, 2.0, 3.0],
...     [4.0, 5.0, 6.0],
... ])
>>> fig = plot_heatmap(
...     data=matrix,
...     title="Example Heatmap",
...     xaxis_title="Columns",
...     yaxis_title="Rows",
...     path="heatmap.png",
... )

The function logs the figure to MLflow automatically if an MLflow run is active:

>>> import mlflow
>>> with mlflow.start_run():
...     plot_heatmap(
...         data=matrix,
...         title="MLflow Heatmap",
...         xaxis_title="Columns",
...         yaxis_title="Rows",
...         path="figures/heatmap.png",
...     )
Source code in aidevelopementtoolkit/logging_utils/plotly_utils.py
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def plot_heatmap(
        data: np.ndarray,
        title: str,
        xaxis_title: str,
        yaxis_title: str,
        path: Optional[str] = None,
        xticklabels: Optional[List[str]] = None,
        yticklabels: Optional[List[str]] = None,
        zrange: Optional[Tuple[float, float]] = None,
    ) -> go.Figure:
    """Plot a matrix as an annotated heatmap.

    Parameters
    ----------
    data : np.ndarray
        Matrix to plot with shape `(N, M)`.

    title : str
        Plot title.

    xaxis_title : str
        Title for the X-axis.

    yaxis_title : str
        Title for the Y-axis.

    path : str
        Path where the figure will be saved. If an MLFlow
        run is started, the figure is logged in the given `path`.

    xticklabels : Optional[List[str]], default=None
        Labels for the X-axis ticks. Must have length equal to the number of
        columns in `data`. If `None`, column indices are used.

    yticklabels : Optional[List[str]], default=None
        Labels for the Y-axis ticks. Must have length equal to the number of
        rows in `data`. If `None`, row indices are used.

    zrange : Optional[Tuple[float, float]], default=None
        Tuple specifying the minimum and maximum values for the color scale.
        When `None` the minimum and maximum values of `data` are used.

    Returns
    -------
    go.Figure
        Matrix figure.

    Examples
    --------
    Create and save a heatmap from a NumPy matrix:

    >>> import numpy as np
    >>> matrix = np.array([
    ...     [1.0, 2.0, 3.0],
    ...     [4.0, 5.0, 6.0],
    ... ])
    >>> fig = plot_heatmap(
    ...     data=matrix,
    ...     title="Example Heatmap",
    ...     xaxis_title="Columns",
    ...     yaxis_title="Rows",
    ...     path="heatmap.png",
    ... )

    The function logs the figure to MLflow automatically if an MLflow
    run is active:

    >>> import mlflow
    >>> with mlflow.start_run():
    ...     plot_heatmap(
    ...         data=matrix,
    ...         title="MLflow Heatmap",
    ...         xaxis_title="Columns",
    ...         yaxis_title="Rows",
    ...         path="figures/heatmap.png",
    ...     )
    """

    data = np.asarray(data, dtype=np.float32)

    check_shape(data, (-1, -1))

    if zrange is not None:
        zmin, zmax = zrange
    else:
        data_min = np.min(data)
        data_max = np.max(data)

        if data_min == data_max:
            zmin = data_min - 1
            zmax = data_max + 1
        else:
            zmin = data_min
            zmax = data_max

    n_rows, n_cols = data.shape

    fig = go.Figure(
        data=go.Heatmap(
            z=data,
            colorscale="Blues",
            zmin=zmin,
            zmax=zmax,
            text=np.round(data, 2),
            texttemplate="%{z:.2f}",
            textfont={"size": 12},
            colorbar=dict(title="Value"),
            hovertemplate=(
                "Row: %{y}<br>"
                "Col: %{x}<br>"
                "Value: %{z:.2f}<extra></extra>"
            ),
        )
    )

    fig.update_layout(
        title=title,
        xaxis_title=xaxis_title,
        yaxis_title=yaxis_title,
    )

    fig.update_xaxes(
        tickmode="array",
        tickvals=list(range(n_cols)),
        ticktext=xticklabels if xticklabels is not None else [str(i) for i in range(n_cols)],
        side="bottom",
    )

    fig.update_yaxes(
        tickmode="array",
        tickvals=list(range(n_rows)),
        ticktext=yticklabels if yticklabels is not None else [str(i) for i in range(n_rows)],
        autorange="reversed",
    )

    if path is not None:
        if mlflow.active_run() is not None:
            mlflow.log_figure(fig, path)
        else:
            fig.write_image(path)

    return fig

plot_scatter(x: np.ndarray, y: np.ndarray, title: str, xaxis_title: str, yaxis_title: str, path: Optional[str] = None, labels: Optional[np.ndarray] = None, marker_size: int = 8, marker_opacity: float = 1, palette: str = 'Plotly', xticklabels: Optional[List[str]] = None, yticklabels: Optional[List[str]] = None) -> go.Figure

Plot a scatter plot.

Parameters:
  • x (ndarray) –

    X coordinates of the points. Shape (N,).

  • y (ndarray) –

    Y coordinates of the points. Shape (N,).

  • title (str) –

    Plot title.

  • xaxis_title (str) –

    Title for the X-axis.

  • yaxis_title (str) –

    Title for the Y-axis.

  • path (str, default: None ) –

    Path where the figure will be saved. If an MLFlow run is started, the figure is logged in the given path.

  • labels (Optional[ndarray], default: None ) –

    Class labels associated with each point. Shape (N,). Each unique label is assigned a different color.

  • marker_size (int, default: 8 ) –

    Marker size.

  • marker_opacity (float, default: 1 ) –

    Marker opacity.

  • palette (str, default: "Plotly" ) –

    Qualitative Plotly color palette to use when labels are provided. Examples: "Plotly", "D3", "Set1", "Set2", "Dark24".

  • xticklabels (Optional[List[str]], default: None ) –

    Custom labels for the X-axis ticks. If None, Plotly defaults are used.

  • yticklabels (Optional[List[str]], default: None ) –

    Custom labels for the Y-axis ticks. If None, Plotly defaults are used.

Returns:
  • Figure

    Scatter plot figure.

Examples:

Create a simple scatter plot:

>>> import numpy as np
>>> x = np.array([1, 2, 3, 4])
>>> y = np.array([2, 4, 1, 5])
>>> fig = plot_scatter(
...     x=x,
...     y=y,
...     title="Example Scatter Plot",
...     xaxis_title="X",
...     yaxis_title="Y",
...     path="scatter.png",
... )

Create a scatter plot with class labels:

>>> labels = np.array(["cat", "dog", "cat", "dog"])
>>> fig = plot_scatter(
...     x=x,
...     y=y,
...     labels=labels,
...     title="Scatter Plot by Class",
...     xaxis_title="X",
...     yaxis_title="Y",
...     path="scatter_labels.png",
...     palette="Set2",
... )

The function logs the figure to MLflow automatically if an MLflow run is active:

>>> import mlflow
>>> with mlflow.start_run():
...     plot_scatter(
...         x=x,
...         y=y,
...         title="MLflow Scatter Plot",
...         xaxis_title="X",
...         yaxis_title="Y",
...         path="figures/scatter.png",
...     )
Source code in aidevelopementtoolkit/logging_utils/plotly_utils.py
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
def plot_scatter(
        x: np.ndarray,
        y: np.ndarray,
        title: str,
        xaxis_title: str,
        yaxis_title: str,
        path: Optional[str] = None,
        labels: Optional[np.ndarray] = None,
        marker_size: int = 8,
        marker_opacity: float = 1,
        palette: str = "Plotly",
        xticklabels: Optional[List[str]] = None,
        yticklabels: Optional[List[str]] = None,
    ) -> go.Figure:
    """Plot a scatter plot.

    Parameters
    ----------
    x : np.ndarray
        X coordinates of the points. Shape `(N,)`.

    y : np.ndarray
        Y coordinates of the points. Shape `(N,)`.

    title : str
        Plot title.

    xaxis_title : str
        Title for the X-axis.

    yaxis_title : str
        Title for the Y-axis.

    path : str
        Path where the figure will be saved. If an MLFlow
        run is started, the figure is logged in the given `path`.

    labels : Optional[np.ndarray], default=None
        Class labels associated with each point. Shape `(N,)`.
        Each unique label is assigned a different color.

    marker_size : int, default=8
        Marker size.

    marker_opacity : float, default=1
        Marker opacity.

    palette : str, default="Plotly"
        Qualitative Plotly color palette to use when labels are provided.
        Examples: "Plotly", "D3", "Set1", "Set2", "Dark24".

    xticklabels : Optional[List[str]], default=None
        Custom labels for the X-axis ticks. If `None`, Plotly defaults are used.

    yticklabels : Optional[List[str]], default=None
        Custom labels for the Y-axis ticks. If `None`, Plotly defaults are used.

    Returns
    -------
    go.Figure
        Scatter plot figure.

    Examples
    --------
    Create a simple scatter plot:

    >>> import numpy as np
    >>> x = np.array([1, 2, 3, 4])
    >>> y = np.array([2, 4, 1, 5])
    >>> fig = plot_scatter(
    ...     x=x,
    ...     y=y,
    ...     title="Example Scatter Plot",
    ...     xaxis_title="X",
    ...     yaxis_title="Y",
    ...     path="scatter.png",
    ... )

    Create a scatter plot with class labels:

    >>> labels = np.array(["cat", "dog", "cat", "dog"])
    >>> fig = plot_scatter(
    ...     x=x,
    ...     y=y,
    ...     labels=labels,
    ...     title="Scatter Plot by Class",
    ...     xaxis_title="X",
    ...     yaxis_title="Y",
    ...     path="scatter_labels.png",
    ...     palette="Set2",
    ... )

    The function logs the figure to MLflow automatically if an MLflow
    run is active:

    >>> import mlflow
    >>> with mlflow.start_run():
    ...     plot_scatter(
    ...         x=x,
    ...         y=y,
    ...         title="MLflow Scatter Plot",
    ...         xaxis_title="X",
    ...         yaxis_title="Y",
    ...         path="figures/scatter.png",
    ...     )
    """

    x = np.asarray(x)
    y = np.asarray(y)

    check_shape(x, (-1,))
    check_shape(y, x.shape)

    if labels is not None:
        labels = np.asarray(labels)

        check_shape(labels, x.shape)

    fig = go.Figure()

    if labels is None:
        fig.add_trace(
            go.Scatter(
                x=x,
                y=y,
                mode="markers",
                marker=dict(
                    size=marker_size,
                    opacity=marker_opacity,
                ),
            )
        )

    else:
        # Preserve the original label order
        unique_labels = list(dict.fromkeys(labels))

        # Check palette existence
        if not hasattr(px.colors.qualitative, palette):
            available_palettes = [
                p
                for p in dir(px.colors.qualitative)
                if not p.startswith("_")
            ]

            logger.error(
                f"Unknown palette '{palette}'. "
                f"Available palettes: {available_palettes}"
            )
            raise ValueError(f"Unknown palette: {palette}")

        colors = getattr(px.colors.qualitative, palette)

        # Repeat colors if there are more classes than available colors
        colors = [
            colors[i % len(colors)]
            for i in range(len(unique_labels))
        ]

        label_to_color = dict(zip(unique_labels, colors))

        # Create one scatter trace per class
        for label in unique_labels:
            mask = labels == label

            fig.add_trace(
                go.Scatter(
                    x=x[mask],
                    y=y[mask],
                    mode="markers",
                    name=str(label),
                    marker=dict(
                        size=marker_size,
                        opacity=marker_opacity,
                        color=label_to_color[label],
                    ),
                )
            )

    fig.update_layout(
        title=title,
        xaxis_title=xaxis_title,
        yaxis_title=yaxis_title,
    )

    if xticklabels is not None:
        fig.update_xaxes(tickmode="array", tickvals=list(range(len(xticklabels))), ticktext=xticklabels)
    if yticklabels is not None:
        fig.update_yaxes(tickmode="array", tickvals=list(range(len(yticklabels))), ticktext=yticklabels)

    if path is not None:
        if mlflow.active_run() is not None:
            mlflow.log_figure(fig, path)
        else:
            fig.write_image(path)

    return fig

plot_histogram(x: np.ndarray, title: str, xaxis_title: str, yaxis_title: str, path: Optional[str] = None, nbins: Optional[int] = None, color: Optional[str] = None, opacity: float = 0.75, xticklabels: Optional[List[str]] = None, yticklabels: Optional[List[str]] = None) -> go.Figure

Plot a histogram.

Parameters:
  • x (ndarray) –

    Data to plot. Shape (N,).

  • title (str) –

    Plot title.

  • xaxis_title (str) –

    Title for the X-axis.

  • yaxis_title (str) –

    Title for the Y-axis.

  • path (str, default: None ) –

    Path where the figure will be saved. If an MLFlow run is started, the figure is logged in the given path.

  • nbins (Optional[int], default: None ) –

    Number of bins. If None, Plotly selects the number of bins automatically.

  • color (Optional[str], default: None ) –

    Bar color as a CSS color string (e.g. "steelblue"). If None, the default Plotly color is used.

  • opacity (float, default: 0.75 ) –

    Bar opacity between 0 and 1.

  • xticklabels (Optional[List[str]], default: None ) –

    Custom labels for the X-axis ticks. If None, Plotly defaults are used.

  • yticklabels (Optional[List[str]], default: None ) –

    Custom labels for the Y-axis ticks. If None, Plotly defaults are used.

Returns:
  • Figure

    Histogram figure.

Examples:

Create a simple histogram:

>>> import numpy as np
>>> x = np.random.randn(500)
>>> fig = plot_histogram(
...     x=x,
...     title="Example Histogram",
...     xaxis_title="Value",
...     yaxis_title="Count",
...     path="histogram.png",
... )

Create a histogram with a fixed number of bins and a custom color:

>>> fig = plot_histogram(
...     x=x,
...     title="Custom Histogram",
...     xaxis_title="Value",
...     yaxis_title="Count",
...     path="histogram_custom.png",
...     nbins=30,
...     color="steelblue",
...     opacity=0.8,
... )

The function logs the figure to MLflow automatically if an MLflow run is active:

>>> import mlflow
>>> with mlflow.start_run():
...     plot_histogram(
...         x=x,
...         title="MLflow Histogram",
...         xaxis_title="Value",
...         yaxis_title="Count",
...         path="figures/histogram.png",
...     )
Source code in aidevelopementtoolkit/logging_utils/plotly_utils.py
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
def plot_histogram(
        x: np.ndarray,
        title: str,
        xaxis_title: str,
        yaxis_title: str,
        path: Optional[str] = None,
        nbins: Optional[int] = None,
        color: Optional[str] = None,
        opacity: float = 0.75,
        xticklabels: Optional[List[str]] = None,
        yticklabels: Optional[List[str]] = None,
    ) -> go.Figure:
    """Plot a histogram.

    Parameters
    ----------
    x : np.ndarray
        Data to plot. Shape `(N,)`.

    title : str
        Plot title.

    xaxis_title : str
        Title for the X-axis.

    yaxis_title : str
        Title for the Y-axis.

    path : str
        Path where the figure will be saved. If an MLFlow
        run is started, the figure is logged in the given `path`.

    nbins : Optional[int], default=None
        Number of bins. If `None`, Plotly selects the number
        of bins automatically.

    color : Optional[str], default=None
        Bar color as a CSS color string (e.g. `"steelblue"`).
        If `None`, the default Plotly color is used.

    opacity : float, default=0.75
        Bar opacity between 0 and 1.

    xticklabels : Optional[List[str]], default=None
        Custom labels for the X-axis ticks. If `None`, Plotly defaults are used.

    yticklabels : Optional[List[str]], default=None
        Custom labels for the Y-axis ticks. If `None`, Plotly defaults are used.

    Returns
    -------
    go.Figure
        Histogram figure.

    Examples
    --------
    Create a simple histogram:

    >>> import numpy as np
    >>> x = np.random.randn(500)
    >>> fig = plot_histogram(
    ...     x=x,
    ...     title="Example Histogram",
    ...     xaxis_title="Value",
    ...     yaxis_title="Count",
    ...     path="histogram.png",
    ... )

    Create a histogram with a fixed number of bins and a custom color:

    >>> fig = plot_histogram(
    ...     x=x,
    ...     title="Custom Histogram",
    ...     xaxis_title="Value",
    ...     yaxis_title="Count",
    ...     path="histogram_custom.png",
    ...     nbins=30,
    ...     color="steelblue",
    ...     opacity=0.8,
    ... )

    The function logs the figure to MLflow automatically if an MLflow
    run is active:

    >>> import mlflow
    >>> with mlflow.start_run():
    ...     plot_histogram(
    ...         x=x,
    ...         title="MLflow Histogram",
    ...         xaxis_title="Value",
    ...         yaxis_title="Count",
    ...         path="figures/histogram.png",
    ...     )
    """

    x = np.asarray(x, dtype=float)

    check_shape(x, (-1,))

    valid_x = x[~np.isnan(x)]

    counts, bin_edges = np.histogram(valid_x, bins=nbins if nbins is not None else "auto")
    bin_centers = (bin_edges[:-1] + bin_edges[1:]) / 2
    bin_width = bin_edges[1] - bin_edges[0]

    fig = go.Figure(
        data=go.Bar(
            x=bin_centers,
            y=counts,
            width=bin_width * 0.95,
            marker=dict(
                color=color if color is not None else "skyblue",
                line=dict(color="black", width=1),
                opacity=opacity,
            ),
        )
    )

    fig.update_layout(
        title=title,
        xaxis_title=xaxis_title,
        yaxis_title=yaxis_title,
        bargap=0.05,
    )

    if xticklabels is not None:
        fig.update_xaxes(tickmode="array", tickvals=list(range(len(xticklabels))), ticktext=xticklabels)
    if yticklabels is not None:
        fig.update_yaxes(tickmode="array", tickvals=list(range(len(yticklabels))), ticktext=yticklabels)

    if path is not None:
        if mlflow.active_run() is not None:
            mlflow.log_figure(fig, path)
        else:
            fig.write_image(path)

    return fig