plot_table

vega_spec_name: 'str',
data_table: 'wandb.Table',
fields: 'dict[str, Any]',
string_fields: 'dict[str, Any] | None' = None,
split_table: 'bool' = False

Description

Creates a custom charts using a Vega-Lite specification and a wandb.Table.

This function creates a custom chart based on a Vega-Lite specification and a data table represented by a wandb.Table object. The specification needs to be predefined and stored in the W&B backend. The function returns a custom chart object that can be logged to W&B using wandb.Run.log().

Args:

• vega_spec_name: The name or identifier of the Vega-Lite spec that defines the visualization structure.
• data_table: A wandb.Table object containing the data to be visualized.
• fields: A mapping between the fields in the Vega-Lite spec and the corresponding columns in the data table to be visualized.
• string_fields: A dictionary for providing values for any string constants required by the custom visualization.
• 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.

Returns:

• CustomChart: A custom chart object that can be logged to W&B. To log the chart, pass the chart object as argument to wandb.Run.log().
• Raises:
• wandb.Error: If data_table is not a wandb.Table object.

Examples:

# Create a custom chart using a Vega-Lite spec and the data table.
import wandb

data = [[1, 1], [2, 2], [3, 3], [4, 4], [5, 5]]
table = wandb.Table(data=data, columns=["x", "y"])
fields = {"x": "x", "y": "y", "title": "MY TITLE"}

with wandb.init() as run:
    # Training code goes here

    # Create a custom title with `string_fields`.
    my_custom_chart = wandb.plot_table(
        vega_spec_name="wandb/line/v0",
        data_table=table,
        fields=fields,
        string_fields={"title": "Title"},
    )

    run.log({"custom_chart": my_custom_chart})