wandb 0.20.2rc20250616__py3-none-any.whl → 0.21.0__py3-none-any.whl

wandb/automations/events.py

@@ -1,7 +1,5 @@
 """Events that trigger W&B Automations."""
 
-# ruff: noqa: UP007  # Avoid using `X | Y` for union fields, as this can cause issues with pydantic < 2.6
-
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Literal, Optional, Union

wandb/integration/catboost/catboost.py

@@ -22,7 +22,9 @@ class WandbCallback:
 
     Example:
         ```
-        train_pool = Pool(train[features], label=train["label"], cat_features=cat_features)
+        train_pool = Pool(
+            train[features], label=train["label"], cat_features=cat_features
+        )
         test_pool = Pool(test[features], label=test["label"], cat_features=cat_features)
 
         model = CatBoostRegressor(
@@ -130,7 +132,9 @@ def log_summary(
 
     Example:
         ```python
-        train_pool = Pool(train[features], label=train["label"], cat_features=cat_features)
+        train_pool = Pool(
+            train[features], label=train["label"], cat_features=cat_features
+        )
         test_pool = Pool(test[features], label=test["label"], cat_features=cat_features)
 
         model = CatBoostRegressor(

wandb/integration/kfp/kfp_patch.py

@@ -270,7 +270,9 @@ def create_component_from_func(
         Example of a component function declaring file input and output::
 
             def catboost_train_classifier(
-                training_data_path: InputPath("CSV"),  # Path to input data file of type "CSV"
+                training_data_path: InputPath(
+                    "CSV"
+                ),  # Path to input data file of type "CSV"
                 trained_model_path: OutputPath(
                     "CatBoostModel"
                 ),  # Path to output data file of type "CatBoostModel"

wandb/integration/sb3/sb3.py

@@ -106,9 +106,9 @@ class WandbCallback(BaseCallback):
             os.makedirs(self.model_save_path, exist_ok=True)
             self.path = os.path.join(self.model_save_path, "model.zip")
         else:
-            assert (
-                self.model_save_freq == 0
-            ), "to use the `model_save_freq` you have to set the `model_save_path` parameter"
+            assert self.model_save_freq == 0, (
+                "to use the `model_save_freq` you have to set the `model_save_path` parameter"
+            )
 
     def _init_callback(self) -> None:
         d = {}

wandb/integration/ultralytics/callback.py

@@ -102,7 +102,9 @@ class WandBUltralyticsCallback:
         model = YOLO("yolov8n.pt")
 
         # add wandb callback
-        add_wandb_callback(model, max_validation_batches=2, enable_model_checkpointing=True)
+        add_wandb_callback(
+            model, max_validation_batches=2, enable_model_checkpointing=True
+        )
 
         # train
         model.train(data="coco128.yaml", epochs=5, imgsz=640)
@@ -454,7 +456,9 @@ def add_wandb_callback(
         model = YOLO("yolov8n.pt")
 
         # add wandb callback
-        add_wandb_callback(model, max_validation_batches=2, enable_model_checkpointing=True)
+        add_wandb_callback(
+            model, max_validation_batches=2, enable_model_checkpointing=True
+        )
 
         # train
         model.train(data="coco128.yaml", epochs=5, imgsz=640)

wandb/plot/__init__.py

@@ -14,6 +14,8 @@ __all__ = [
     "pr_curve",
     "confusion_matrix",
     "line_series",
+    "plot_table",
+    "visualize",  # doc:exclude
 ]
 
 from wandb.plot.bar import bar

wandb/plot/bar.py

@@ -19,11 +19,11 @@ def bar(
     """Constructs a bar chart from a wandb.Table of data.
 
     Args:
-        table (wandb.Table): A table containing the data for the bar chart.
-        label (str): The name of the column to use for the labels of each bar.
-        value (str): The name of the column to use for the values of each bar.
-        title (str): The title of the bar chart.
-        split_table (bool): Whether the table should be split into a separate section
+        table: A table containing the data for the bar chart.
+        label: The name of the column to use for the labels of each bar.
+        value: The name of the column to use for the values of each bar.
+        title: The title of the bar chart.
+        split_table: Whether the table should be split into a separate section
             in the W&B UI. If `True`, the table will be displayed in a section named
             "Custom Chart Tables". Default is `False`.
 
@@ -32,34 +32,35 @@ def bar(
             chart, pass it to `wandb.log()`.
 
     Example:
-        ```
-        import random
-        import wandb
 
-        # Generate random data for the table
-        data = [
-            ["car", random.uniform(0, 1)],
-            ["bus", random.uniform(0, 1)],
-            ["road", random.uniform(0, 1)],
-            ["person", random.uniform(0, 1)],
-        ]
+    ```python
+    import random
+    import wandb
+
+    # Generate random data for the table
+    data = [
+        ["car", random.uniform(0, 1)],
+        ["bus", random.uniform(0, 1)],
+        ["road", random.uniform(0, 1)],
+        ["person", random.uniform(0, 1)],
+    ]
 
-        # Create a table with the data
-        table = wandb.Table(data=data, columns=["class", "accuracy"])
+    # Create a table with the data
+    table = wandb.Table(data=data, columns=["class", "accuracy"])
 
-        # Initialize a W&B run and log the bar plot
-        with wandb.init(project="bar_chart") as run:
-            # Create a bar plot from the table
-            bar_plot = wandb.plot.bar(
-                table=table,
-                label="class",
-                value="accuracy",
-                title="Object Classification Accuracy",
-            )
+    # Initialize a W&B run and log the bar plot
+    with wandb.init(project="bar_chart") as run:
+        # Create a bar plot from the table
+        bar_plot = wandb.plot.bar(
+            table=table,
+            label="class",
+            value="accuracy",
+            title="Object Classification Accuracy",
+        )
 
-            # Log the bar chart to W&B
-            run.log({"bar_plot": bar_plot})
-        ```
+        # Log the bar chart to W&B
+        run.log({"bar_plot": bar_plot})
+    ```
     """
     return plot_table(
         data_table=table,

wandb/plot/confusion_matrix.py

@@ -23,16 +23,16 @@ def confusion_matrix(
     """Constructs a confusion matrix from a sequence of probabilities or predictions.
 
     Args:
-        probs (Sequence[Sequence[float]] | None): A sequence of predicted probabilities for each
+        probs: A sequence of predicted probabilities for each
             class. The sequence shape should be (N, K) where N is the number of samples
             and K is the number of classes. If provided, `preds` should not be provided.
-        y_true (Sequence[T] | None): A sequence of true labels.
-        preds (Sequence[T] | None): A sequence of predicted class labels. If provided,
+        y_true: A sequence of true labels.
+        preds: A sequence of predicted class labels. If provided,
             `probs` should not be provided.
-        class_names (Sequence[str] | None): Sequence of class names. If not
+        class_names: Sequence of class names. If not
             provided, class names will be defined as "Class_1", "Class_2", etc.
-        title (str): Title of the confusion matrix chart.
-        split_table (bool): Whether the table should be split into a separate section
+        title: Title of the confusion matrix chart.
+        split_table: Whether the table should be split into a separate section
             in the W&B UI. If `True`, the table will be displayed in a section named
             "Custom Chart Tables". Default is `False`.
 
@@ -48,75 +48,79 @@ def confusion_matrix(
         wandb.Error: If numpy is not installed.
 
     Examples:
-        1. Logging a confusion matrix with random probabilities for wildlife
-        classification:
-        ```
-        import numpy as np
-        import wandb
-
-        # Define class names for wildlife
-        wildlife_class_names = ["Lion", "Tiger", "Elephant", "Zebra"]
-
-        # Generate random true labels (0 to 3 for 10 samples)
-        wildlife_y_true = np.random.randint(0, 4, size=10)
-
-       # Generate random probabilities for each class (10 samples x 4 classes)
-        wildlife_probs = np.random.rand(10, 4)
-        wildlife_probs = np.exp(wildlife_probs) / np.sum(
-            np.exp(wildlife_probs),
-            axis=1,
-            keepdims=True,
+    Logging a confusion matrix with random probabilities for wildlife
+    classification:
+
+    ```python
+    import numpy as np
+    import wandb
+
+    # Define class names for wildlife
+    wildlife_class_names = ["Lion", "Tiger", "Elephant", "Zebra"]
+
+    # Generate random true labels (0 to 3 for 10 samples)
+    wildlife_y_true = np.random.randint(0, 4, size=10)
+
+    # Generate random probabilities for each class (10 samples x 4 classes)
+    wildlife_probs = np.random.rand(10, 4)
+    wildlife_probs = np.exp(wildlife_probs) / np.sum(
+        np.exp(wildlife_probs),
+        axis=1,
+        keepdims=True,
+    )
+
+    # Initialize W&B run and log confusion matrix
+    with wandb.init(project="wildlife_classification") as run:
+        confusion_matrix = wandb.plot.confusion_matrix(
+            probs=wildlife_probs,
+            y_true=wildlife_y_true,
+            class_names=wildlife_class_names,
+            title="Wildlife Classification Confusion Matrix",
         )
+        run.log({"wildlife_confusion_matrix": confusion_matrix})
+    ```
+
+    In this example, random probabilities are used to generate a confusion
+    matrix.
+
+    Logging a confusion matrix with simulated model predictions and 85%
+    accuracy:
 
-        # Initialize W&B run and log confusion matrix
-        with wandb.init(project="wildlife_classification") as run:
-            confusion_matrix = wandb.plot.confusion_matrix(
-                    probs=wildlife_probs,
-                    y_true=wildlife_y_true,
-                    class_names=wildlife_class_names,
-                    title="Wildlife Classification Confusion Matrix",
-                )
-            run.log({"wildlife_confusion_matrix": confusion_matrix})
-        ```
-        In this example, random probabilities are used to generate a confusion
-        matrix.
-
-        2. Logging a confusion matrix with simulated model predictions and 85%
-        accuracy:
-        ```
-        import numpy as np
-        import wandb
-
-        # Define class names for wildlife
-        wildlife_class_names = ["Lion", "Tiger", "Elephant", "Zebra"]
-
-        # Simulate true labels for 200 animal images (imbalanced distribution)
-        wildlife_y_true = np.random.choice(
-            [0, 1, 2, 3],
-            size=200,
-            p=[0.2, 0.3, 0.25, 0.25],
+    ```python
+    import numpy as np
+    import wandb
+
+    # Define class names for wildlife
+    wildlife_class_names = ["Lion", "Tiger", "Elephant", "Zebra"]
+
+    # Simulate true labels for 200 animal images (imbalanced distribution)
+    wildlife_y_true = np.random.choice(
+        [0, 1, 2, 3],
+        size=200,
+        p=[0.2, 0.3, 0.25, 0.25],
+    )
+
+    # Simulate model predictions with 85% accuracy
+    wildlife_preds = [
+        y_t
+        if np.random.rand() < 0.85
+        else np.random.choice([x for x in range(4) if x != y_t])
+        for y_t in wildlife_y_true
+    ]
+
+    # Initialize W&B run and log confusion matrix
+    with wandb.init(project="wildlife_classification") as run:
+        confusion_matrix = wandb.plot.confusion_matrix(
+            preds=wildlife_preds,
+            y_true=wildlife_y_true,
+            class_names=wildlife_class_names,
+            title="Simulated Wildlife Classification Confusion Matrix",
         )
+        run.log({"wildlife_confusion_matrix": confusion_matrix})
+    ```
 
-        # Simulate model predictions with 85% accuracy
-        wildlife_preds = [
-            y_t
-            if np.random.rand() < 0.85
-            else np.random.choice([x for x in range(4) if x != y_t])
-            for y_t in wildlife_y_true
-        ]
-
-        # Initialize W&B run and log confusion matrix
-        with wandb.init(project="wildlife_classification") as run:
-            confusion_matrix = wandb.plot.confusion_matrix(
-                preds=wildlife_preds,
-                y_true=wildlife_y_true,
-                class_names=wildlife_class_names,
-                title="Simulated Wildlife Classification Confusion Matrix"
-            )
-            run.log({"wildlife_confusion_matrix": confusion_matrix})
-        ```
-        In this example, predictions are simulated with 85% accuracy to generate a
-        confusion matrix.
+    In this example, predictions are simulated with 85% accuracy to generate a
+    confusion matrix.
     """
     np = util.get_module(
         "numpy",

wandb/plot/histogram.py

@@ -18,10 +18,10 @@ def histogram(
     """Constructs a histogram chart from a W&B Table.
 
     Args:
-        table (wandb.Table): The W&B Table containing the data for the histogram.
-        value (str): The label for the bin axis (x-axis).
-        title (str): The title of the histogram plot.
-        split_table (bool): Whether the table should be split into a separate section
+        table: The W&B Table containing the data for the histogram.
+        value: The label for the bin axis (x-axis).
+        title: The title of the histogram plot.
+        split_table: Whether the table should be split into a separate section
             in the W&B UI. If `True`, the table will be displayed in a section named
             "Custom Chart Tables". Default is `False`.
 
@@ -30,31 +30,32 @@ def histogram(
             chart, pass it to `wandb.log()`.
 
     Example:
-        ```
-        import math
-        import random
-        import wandb
 
-        # Generate random data
-        data = [[i, random.random() + math.sin(i / 10)] for i in range(100)]
+    ```python
+    import math
+    import random
+    import wandb
+
+    # Generate random data
+    data = [[i, random.random() + math.sin(i / 10)] for i in range(100)]
 
-        # Create a W&B Table
-        table = wandb.Table(
-            data=data,
-            columns=["step", "height"],
-        )
+    # Create a W&B Table
+    table = wandb.Table(
+        data=data,
+        columns=["step", "height"],
+    )
 
-        # Create a histogram plot
-        histogram = wandb.plot.histogram(
-            table,
-            value="height",
-            title="My Histogram",
-        )
+    # Create a histogram plot
+    histogram = wandb.plot.histogram(
+        table,
+        value="height",
+        title="My Histogram",
+    )
 
-        # Log the histogram plot to W&B
-        with wandb.init(...) as run:
-            run.log({"histogram-plot1": histogram})
-        ```
+    # Log the histogram plot to W&B
+    with wandb.init(...) as run:
+        run.log({"histogram-plot1": histogram})
+    ```
     """
     return plot_table(
         data_table=table,

wandb/plot/line.py

@@ -20,13 +20,13 @@ def line(
     """Constructs a customizable line chart.
 
     Args:
-        table (wandb.Table):  The table containing data for the chart.
-        x (str): Column name for the x-axis values.
-        y (str): Column name for the y-axis values.
-        stroke (str):Column name to differentiate line strokes (e.g., for
+        table:  The table containing data for the chart.
+        x: Column name for the x-axis values.
+        y: Column name for the y-axis values.
+        stroke: Column name to differentiate line strokes (e.g., for
             grouping lines).
-        title (str):Title of the chart.
-        split_table (bool): Whether the table should be split into a separate section
+        title: Title of the chart.
+        split_table: Whether the table should be split into a separate section
             in the W&B UI. If `True`, the table will be displayed in a section named
             "Custom Chart Tables". Default is `False`.
 
@@ -35,35 +35,36 @@ def line(
             chart, pass it to `wandb.log()`.
 
     Example:
-       ```python
-        import math
-        import random
-        import wandb
 
-        # Create multiple series of data with different patterns
-        data = []
-        for i in range(100):
-            # Series 1: Sinusoidal pattern with random noise
-            data.append([i, math.sin(i / 10) + random.uniform(-0.1, 0.1), "series_1"])
-            # Series 2: Cosine pattern with random noise
-            data.append([i, math.cos(i / 10) + random.uniform(-0.1, 0.1), "series_2"])
-            # Series 3: Linear increase with random noise
-            data.append([i, i / 10 + random.uniform(-0.5, 0.5), "series_3"])
+    ```python
+    import math
+    import random
+    import wandb
+
+    # Create multiple series of data with different patterns
+    data = []
+    for i in range(100):
+        # Series 1: Sinusoidal pattern with random noise
+        data.append([i, math.sin(i / 10) + random.uniform(-0.1, 0.1), "series_1"])
+        # Series 2: Cosine pattern with random noise
+        data.append([i, math.cos(i / 10) + random.uniform(-0.1, 0.1), "series_2"])
+        # Series 3: Linear increase with random noise
+        data.append([i, i / 10 + random.uniform(-0.5, 0.5), "series_3"])
 
-        # Define the columns for the table
-        table = wandb.Table(data=data, columns=["step", "value", "series"])
+    # Define the columns for the table
+    table = wandb.Table(data=data, columns=["step", "value", "series"])
 
-        # Initialize wandb run and log the line chart
-        with wandb.init(project="line_chart_example") as run:
-            line_chart = wandb.plot.line(
-                table=table,
-                x="step",
-                y="value",
-                stroke="series",  # Group by the "series" column
-                title="Multi-Series Line Plot",
-            )
-            run.log({"line-chart": line_chart})
-        ```
+    # Initialize wandb run and log the line chart
+    with wandb.init(project="line_chart_example") as run:
+        line_chart = wandb.plot.line(
+            table=table,
+            x="step",
+            y="value",
+            stroke="series",  # Group by the "series" column
+            title="Multi-Series Line Plot",
+        )
+        run.log({"line-chart": line_chart})
+    ```
     """
     return plot_table(
         data_table=table,