File size: 2,166 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 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 |
from __future__ import annotations
from typing import TYPE_CHECKING
from wandb.plot.custom_chart import plot_table
if TYPE_CHECKING:
import wandb
from wandb.plot.custom_chart import CustomChart
def scatter(
table: wandb.Table,
x: str,
y: str,
title: str = "",
split_table: bool = False,
) -> CustomChart:
"""Constructs a scatter plot from a wandb.Table of data.
Args:
table (wandb.Table): The W&B Table containing the data to visualize.
x (str): The name of the column used for the x-axis.
y (str): The name of the column used for the y-axis.
title (str): The title of the scatter chart.
split_table (bool): 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`.
Returns:
CustomChart: A custom chart object that can be logged to W&B. To log the
chart, pass it to `wandb.log()`.
Example:
```
import math
import random
import wandb
# Simulate temperature variations at different altitudes over time
data = [
[i, random.uniform(-10, 20) - 0.005 * i + 5 * math.sin(i / 50)]
for i in range(300)
]
# Create W&B table with altitude (m) and temperature (°C) columns
table = wandb.Table(data=data, columns=["altitude (m)", "temperature (°C)"])
# Initialize W&B run and log the scatter plot
with wandb.init(project="temperature-altitude-scatter") as run:
# Create and log the scatter plot
scatter_plot = wandb.plot.scatter(
table=table,
x="altitude (m)",
y="temperature (°C)",
title="Altitude vs Temperature",
)
run.log({"altitude-temperature-scatter": scatter_plot})
```
"""
return plot_table(
data_table=table,
vega_spec_name="wandb/scatter/v0",
fields={"x": x, "y": y},
string_fields={"title": title},
split_table=split_table,
)
|