plot_table
2 minute read
function plot_table
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
) → CustomChart
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.log()
.
Args:
vega_spec_name
(str): The name or identifier of the Vega-Lite spec that defines the visualization structure.data_table
(wandb.Table): Awandb.Table
object containing the data to be visualized.fields
(dict[str, Any]): A mapping between the fields in the Vega-Lite spec and the corresponding columns in the data table to be visualized.string_fields
(dict[str, Any] | None): A dictionary for providing values for any string constants required by the custom visualization.split_table
(bool): Whether the table should be split into a separate section in the W&B UI. IfTrue
, the table will be displayed in a section named “Custom Chart Tables”. Default isFalse
.
Returns:
CustomChart
: A custom chart object that can be logged to W&B. To log the chart, pass it towandb.log()
.
Raises:
wandb.Error
: Ifdata_table
is not awandb.Table
object.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.