Last updated
Copyright © 2023 Arize AI, Inc
Last updated
For most users, the Arize platform’s user interface (UI) offers the optimal experience for creating dashboards. The UI provides a live preview of your dashboard, making it easy to visualize changes as you add widgets. Moreover, with Arize’s customizable dashboard templates, you can quickly tailor dashboards to suit your specific requirements.
However, there are scenarios where programmatically creating dashboards might better serve your needs.If you aim to replicate a particular set of widgets across various dashboards, efficiently clone an entire dashboard, or integrate dashboard creation into your automated onboarding workflows, programmatic creation provides exceptional flexibility. This method allows you to handle custom and repeatable dashboard requirements effectively, providing a scalable solution for complex environments.
Programmatically create a dashboard using one of our predefined templates, streamlining the setup process for common use cases
variables
When creating a new custom dashboard, you first need to create an empty state dashboard to add widgets to:
This will return the dashboard id to use in mutations to add widgets.
To visualize data variations and overall distribution patterns on your dashboard, use the createBarChartWidget
mutation.
variable
Use the createLineChartWidget
to add a time series widget to your dashboard, which is perfect for visualizing performance over time, data quality, and analyzing trends with options to add multiple lines or split data by specific criteria.
variables
To effectively monitor data drift, utilize the createLineChartWidget
mutation with the widgetType
input set to driftLineChartWidget
. Below is an example that demonstrates using the PSI. You also have the flexibility to opt for other statistical methods such as Jensen-Shannon distance (JS) or Kullback-Leibler (KL) divergence, depending on your analysis needs.
variables
To get your baselineId you can query your model:
Visualize your monitors using a monitor widget.
variables
Add a statistics widget that displays key metrics, tailored to focus on either performance indicators or data quality metrics. This widget provides a quick overview and valuable insights at a glance.
variables
Add a text widget to your dashboard to offer explanatory text, headings, or contextual information, enriching the dashboard's narrative and usability.
variables