{"id":8078,"date":"2023-11-02T09:44:58","date_gmt":"2023-11-02T17:44:58","guid":{"rendered":"https:\/\/live-cometml.pantheonsite.io\/?p=8078"},"modified":"2025-04-24T17:04:52","modified_gmt":"2025-04-24T17:04:52","slug":"how-to-build-a-customized-panel-in-comet","status":"publish","type":"post","link":"https:\/\/www.comet.com\/site\/blog\/how-to-build-a-customized-panel-in-comet\/","title":{"rendered":"How to Build a Customized Panel in Comet"},"content":{"rendered":"\n
\n
\n
\n
\n
\n
\"\"<\/figure>
<\/picture><\/div>\n<\/div>
Photo by Joshua Hoehne<\/a> on Unsplash<\/a><\/figcaption><\/figure>\n

\n<\/p>

Recently I have discovered a very interesting feature provided by Comet<\/a>: customized Panels<\/strong>. A Panel is a visual display that shows some results as tables or graphs. Results may include performance metrics, dataset statistics, or simply generic data.<\/p>\n

Comet provides a dashboard to build generic Panels. In addition, it provides an SDK that permits the creation of custom Panels either in Python or Javascript. In this article, I describe how to build a custom Panel in Comet.<\/p>\n

The Concept of Panels in Comet<\/h2>\n

Comet is an experimentation platform that provides users with tools and features to track and monitor machine learning experiments. To summarize the results of the experiments, Comet provides a feature called Panels. You can build as many Panels as you want.<\/p>\n

A Panel is not necessarily linked to a specific experiment; rather, it can show results across the different experiments.<\/p>\n

To create a new Panel, after one or more experiments run, you can simply click on the \u2018Add\u2019 button at the top right corner of your dashboard and click \u2018New Panel.\u2019 Then you can choose one of the built-in or featured Panels, as shown in the following figure:<\/p>\n

\n
\n
\"\"<\/figure>
<\/picture><\/div>\n<\/div>\n
Image by Author<\/figcaption>\n<\/figure>\n

The following figure shows an example of a Panel in Comet:<\/p>\n

\n
\n
\"\"<\/figure>
<\/picture><\/div>\n<\/div>\n
Image by Author<\/figcaption>\n<\/figure>\n

Custom Panels<\/h2>\n

Comet provides a Python\/Javascript SDK that permits the creation of custom Panels. At the moment, you can create custom Panels only from the online GUI. To access the GUI, you can click \u2018Add \u2192New Panel\u2019 from the dashboard, and then click on \u2018Create New.\u2019 A new window opens, with an online SDK, as shown in the following figure:<\/p>\n

\n
\n
\"\"<\/figure>
<\/picture><\/div>\n<\/div>\n
Image by Author<\/figcaption>\n<\/figure>\n

\n<\/p>

The SDK presents an editor on the left where you can write your code and a preview of the result on the right. To see the preview, you should click the run button. In the top part of the SDK, you can select your preferred language (Python or Javascript).<\/p>\n

A Comet Panel can receive many options as input. You can specify them in the Options tab of the SDK. You can define options as key-value pairs, as follows:<\/p>\n

{\n \"key1\" : \"value1\",\n \"key2\" : \"value2\",\n ...\n \"keyN\" : \"valueN\"\n}<\/span><\/pre>\n
Custom Panels in Python<\/h2>\n
Comet defines the ui<\/code> subpackage to customize your Panel. Before using it, you must import it as follows:<\/p>\n
from comet_ml import ui<\/span><\/pre>\n
The ui<\/code> subpackage defines the following methods:<\/p>\n