# Metrics Dashboard

Tensorleap provides real-time and historical metrics monitoring. 

The metrics defined in the **Integration Script** are stored during model **Evaluation** for each sample, batch, and epoch. In addition, each sample is monitored and stored with its metadata.

All stored metrics and metadata can be presented aggregatively in a custom **Dashlet**.

## Dashboard

A **Dashboard** is a panel that layouts various metric charts, also called **Dashlets**.

Dashboards in Tensorleap are presented via the **Dashboard** panel, which is shown when you click the  "Dashboard" tab at the top.

To add a new Dashboard, click <img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FvabfQt8rRij7NQT1Vw0b%2Fimage.png?alt=media&#x26;token=0ac4c19c-319e-453d-9ec5-53fba8c96beb" alt="" data-size="line"> at the top bar.

#### Selected Models

The dashboard displays visualizations of the currently selected model(s). To select models, click <img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FFGiZjojRfXD9P8tXu004%2Fimage.png?alt=media&#x26;token=61318270-cde3-48db-bb68-9d9b0c521139" alt="" data-size="line"> to open the Versions panel on the left, expand the version, and select the model(s).

The dashboard will automatically update and show data for the selected models. At the top bar, you can see tags with the selected models. From there, you can also toggle to filter models.

![Models Selection for the Dashboard](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2F5IjN1erfvILwL5RD33oD%2Fimage.png?alt=media\&token=3cf17e48-f03f-4e2e-a1a0-2b92cece3013)

## Dashlet

A **Dashlet** is an interactive visualization that updates in real-time, displaying aggregated metrics against various parameters. To add a new **Dashlet** click <img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FALHzsfk9KCNYsybAvUCr%2Fimage.png?alt=media&#x26;token=a281928a-db19-4f96-966b-b92cc0b03225" alt="" data-size="line"> and choose the chart type on the left.

The different Dashlet types, and their properties, are described below.

### Bar

![Bar Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2F12awLIS1bGJLTvfvESuY%2Fimage.png?alt=media\&token=088ec2a5-91b0-4f0f-831f-8cdac805e8f7)

| Property          | Description                                                                                                                                                                                                                                         |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Dashlet Name`    | The Dashlet's title                                                                                                                                                                                                                                 |
| `Y-axis`          | Points to the metric that is correlated with the bars' height                                                                                                                                                                                       |
| `Aggregation`     | Mathematical operation for aggregating the presented data: Average, Min, Max, Mid, Count                                                                                                                                                            |
| `Scale Y`         | Whether to use a linear, log, or exponential factoring to the data                                                                                                                                                                                  |
| Data Distribution | <ul><li><code>Continuous</code></li><li><p><code>Distinct</code></p><ul><li><code>Order-By</code>: <code>Metric</code> / <code>Alphabetical</code></li><li><code>Order</code>: <code>Ascending</code> / <code>Descending</code></li></ul></li></ul> |
| X-Axis            | The data property the X-Axis represents                                                                                                                                                                                                             |
| `Order By`        | Whether to order the x axis by alphabetical order or by values                                                                                                                                                                                      |
| `Order`           | Ascending or descending                                                                                                                                                                                                                             |
| `Size`            | The number of points on x axis                                                                                                                                                                                                                      |
| `Split By`        | <p>How to split the dashlet to compare different subsets/models/metadata (horizontally, vertically, inner)<br></p><ul><li><code>Split by Model</code>  - How would model comparison split dashlet.</li></ul>                                        |

### Line

![Line Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FeuYfSEf436Qmjv9KamJk%2Fimage.png?alt=media\&token=c076af10-c853-4e1f-bf9a-7260255161ab)

Settings are like the [Bar](#bar)

### Area

![Area Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FmbrhdyHVjkGcd4PlT21N%2Fimage.png?alt=media\&token=f3f63893-3941-4fa0-81bf-a102b490c92b)

Settings are like [bar](#bar)

### Table

![Table Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2Fa9P8MHlJQru2O4RinZLs%2Fimage.png?alt=media\&token=c19521dd-5c5c-4fbe-8dc2-7e92d5dd523c)

| Property   | Description                        |
| ---------- | ---------------------------------- |
| `Name`     | The Dashlet's title                |
| `Metrics`  | Add columns with selected metrics  |
| `Metadata` | Add columns with selected metadata |

###

### HeatMap

![HeatMap Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2F1t4MJqR2VzNfWa21ORGq%2Fimage.png?alt=media\&token=a971f63c-2726-413f-b2ef-395147803331)

| Property   | Description                                                                                                                                                                                                                                                                                                                                                                             |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Name`     | The Dashlet's title                                                                                                                                                                                                                                                                                                                                                                     |
| Color      | <ul><li><code>Field</code>: selected field to be represented by the heat-map's color</li><li><code>Aggregation</code>: mathematical operation for aggregating the presented data: Average, Min, Max, Mid<br></li></ul>                                                                                                                                                                  |
| X-Axis     | <p></p><ul><li><code>Field</code>: selected field to be represented by the x-axis</li><li><p><code>Distribution</code></p><ul><li><code>Continuous</code></li><li><p><code>Distinct</code></p><ul><li><code>Order-By</code>: <code>Metric</code> / <code>Alphabetical</code></li><li><code>Order</code>: <code>Ascending</code> / <code>Descending</code></li></ul></li></ul></li></ul> |
| Y-Axis     | <ul><li><code>Field</code>: selected field to be represented by the y-axis</li><li><p><code>Distribution</code></p><ul><li><code>Continuous</code></li><li><p><code>Distinct</code></p><ul><li><code>Order-By</code>: <code>Metric</code> / <code>Alphabetical</code></li><li><code>Order</code>: <code>Ascending</code> / <code>Descending</code></li></ul></li></ul></li></ul>        |
| `Split By` | <p></p><p>How to split the dashlet to compare different subsets/models/metadata (horizontally, vertically, inner)<br></p><ul><li><code>Split by Model</code>  - How would model comparison split dashlet.</li></ul>                                                                                                                                                                     |

### Donut

![Donut Dashlet](https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2F0PQafYHIzYAzVrqJMAuG%2Fimage.png?alt=media\&token=1a4d15bd-f72d-4254-a08c-a39ec833d045)

| Property                | Description                                                                                                                                                                                                                |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Name`                  | The Dashlet's title                                                                                                                                                                                                        |
| `Slice by Size`         | <ul><li>Count - slice represents the count</li><li>UniquCount - slice represents the unique count</li><li>Sum - slice represents the sum</li></ul>                                                                         |
| `Metric`                | Add a slices with a selected metric                                                                                                                                                                                        |
| `Metadata`              | Add a slices with a selected metadata                                                                                                                                                                                      |
| Display only last epoch | Show results filtered to the latest epoch                                                                                                                                                                                  |
| `Split By`              | <p></p><p></p><p>How to split the dashlet to compare different subsets/models/metadata (horizontally, vertically, inner)<br></p><ul><li><code>Split by Model</code>  - How would model comparison split dashlet.</li></ul> |

### Confusion Matrix

#### F1

<figure><img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FyHTHhmXB4qIqeQp1f1L8%2Fimage.png?alt=media&#x26;token=6ee83706-1708-47cc-844e-876e370f0ea2" alt=""><figcaption><p>F1 metric Dashlet</p></figcaption></figure>

| Property          | Description                                                                                                                                                                                                                                         |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Name`            | The Dashlet's title                                                                                                                                                                                                                                 |
| X-Axis            | The data property the X-Axis represents                                                                                                                                                                                                             |
| Data Distribution | <ul><li><code>Continuous</code></li><li><p><code>Distinct</code></p><ul><li><code>Order-By</code>: <code>Metric</code> / <code>Alphabetical</code></li><li><code>Order</code>: <code>Ascending</code> / <code>Descending</code></li></ul></li></ul> |
| Interval          | The interval on which to aggregate results                                                                                                                                                                                                          |

#### Balanced Accuracy

<figure><img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FmvVHnKBijNncqm0e4twg%2Fimage.png?alt=media&#x26;token=2ca49d38-d568-420a-b2b9-26eddf6c9262" alt=""><figcaption><p>Balanced Accuracy Dashlet</p></figcaption></figure>

| Property          | Description                                                                                                                                                                                                                                         |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Name`            | The Dashlet's title                                                                                                                                                                                                                                 |
| X-Axis            | The data property the X-Axis represents                                                                                                                                                                                                             |
| Data Distribution | <ul><li><code>Continuous</code></li><li><p><code>Distinct</code></p><ul><li><code>Order-By</code>: <code>Metric</code> / <code>Alphabetical</code></li><li><code>Order</code>: <code>Ascending</code> / <code>Descending</code></li></ul></li></ul> |
| Interval          | The interval on which to aggregate results                                                                                                                                                                                                          |

#### PR Curve

<figure><img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2FsLZOgJ5byxAsZGL4cJHQ%2Fimage.png?alt=media&#x26;token=f4634487-2bca-4275-8db6-f342d7fa6ac6" alt=""><figcaption><p>PR Curve Dashlet</p></figcaption></figure>

| Property | Description         |
| -------- | ------------------- |
| `Name`   | The Dashlet's title |

#### ROC Curve

<figure><img src="https://3509361326-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9UXeOlFqlw8pl79U2HGU%2Fuploads%2F8pucmVdImcy9mJGr12pp%2Fimage.png?alt=media&#x26;token=033f6cfb-82af-4db1-aaff-518b47bc9f30" alt=""><figcaption><p>ROC Curve Dashlet</p></figcaption></figure>

| Property | Description         |
| -------- | ------------------- |
| `Name`   | The Dashlet's title |

#### PR Curve