mirror of
https://github.com/clearml/clearml-docs
synced 2025-02-07 13:21:46 +00:00
Add Dashboard GUI app (#303)
This commit is contained in:
parent
63266dd335
commit
d093ce0e62
BIN
docs/img/apps_dashboard.png
Normal file
BIN
docs/img/apps_dashboard.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 144 KiB |
BIN
docs/img/apps_dashboard_wizard.png
Normal file
BIN
docs/img/apps_dashboard_wizard.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
39
docs/webapp/applications/apps_dashboard.md
Normal file
39
docs/webapp/applications/apps_dashboard.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
title: Project Dashboard
|
||||||
|
---
|
||||||
|
|
||||||
|
:::info Pro Plan Offering
|
||||||
|
The ClearML Project Dashboard App is available under the ClearML Pro plan
|
||||||
|
:::
|
||||||
|
|
||||||
|
The Project Dashboard Application provides an overview of a project's progress. It presents an aggregated view of a
|
||||||
|
chosen metric over the project's iterations, as well as project GPU and worker usage. It also supports alerts/warnings
|
||||||
|
on failed Tasks via Slack integration.
|
||||||
|
|
||||||
|
## Project Dashboard Instance Configuration
|
||||||
|
* **Monitored Project** - Name of the ClearML project to monitor
|
||||||
|
* **Monitored Metric**
|
||||||
|
* Monitored Metric - Title - Metric title to track
|
||||||
|
* Monitored Metric - Series - Metric series (variant) to track
|
||||||
|
* Monitored Metric - Trend - Choose whether to track the monitored metric's highest or lowest values
|
||||||
|
* **Dashboard Title** - Name of the project dashboard instance, which will appear in the instance list
|
||||||
|
* **Failed Task Slack Monitor** (Optional)
|
||||||
|
* API Token - Slack workspace access token
|
||||||
|
* Channel Name - Slack channel to which task failure alerts will be posted
|
||||||
|
* Fail Iteration Threshold - Minimum number of iterations to trigger Slack alerts about task failure (failed tasks that do not meet the threshold will be ignored)
|
||||||
|
|
||||||
|
![Dashboard app wizard](../../img/apps_dashboard_wizard.png)
|
||||||
|
|
||||||
|
## Dashboard
|
||||||
|
|
||||||
|
Once a project dashboard instance is launched, its dashboard displays the following information about a project:
|
||||||
|
* Task Status Summary - Percentages of Tasks by status
|
||||||
|
* Task Type Summary - Percentages of local experiments vs. agent experiments
|
||||||
|
* Experiments Summary - Number of tasks by status over time
|
||||||
|
* Monitoring - GPU utilization and GPU memory usage
|
||||||
|
* Metric Monitoring - An aggregated view of the values of a metric over time
|
||||||
|
* Project’s Active Workers - Number of workers currently executing experiments in the monitored project
|
||||||
|
* Workers Table - List of active workers
|
||||||
|
* Failed Experiments - Failed experiments and their time of failure summary
|
||||||
|
|
||||||
|
![App dashboard](../../img/apps_dashboard.png)
|
@ -15,9 +15,9 @@ Configure and launch app instances, then track their execution from the app dash
|
|||||||
ClearML provides the following applications:
|
ClearML provides the following applications:
|
||||||
* [**AWS Autoscaler**](apps_aws_autoscaler.md) - Optimize AWS EC2 instance usage according to a defined instance budget
|
* [**AWS Autoscaler**](apps_aws_autoscaler.md) - Optimize AWS EC2 instance usage according to a defined instance budget
|
||||||
* [**GCP Autoscaler**](apps_gcp_autoscaler.md) - Optimize GCP instance usage according to a defined instance budget
|
* [**GCP Autoscaler**](apps_gcp_autoscaler.md) - Optimize GCP instance usage according to a defined instance budget
|
||||||
* [**Hyperparameter Optimization**](apps_hpo) - Find the parameter values that yield the best performing models
|
* [**Hyperparameter Optimization**](apps_hpo.md) - Find the parameter values that yield the best performing models
|
||||||
* **Nvidia Clara** - Train models using Nvidia’s Clara framework
|
* **Nvidia Clara** - Train models using Nvidia’s Clara framework
|
||||||
* **Project Dashboard** - High-level project monitoring with Slack alerts
|
* [**Project Dashboard**](apps_dashboard.md) - High-level project monitoring with Slack alerts
|
||||||
|
|
||||||
## App Pages Layout
|
## App Pages Layout
|
||||||
Each application’s page is split into two sections:
|
Each application’s page is split into two sections:
|
||||||
|
@ -60,7 +60,8 @@ module.exports = {
|
|||||||
'webapp/applications/apps_overview',
|
'webapp/applications/apps_overview',
|
||||||
'webapp/applications/apps_aws_autoscaler',
|
'webapp/applications/apps_aws_autoscaler',
|
||||||
'webapp/applications/apps_gcp_autoscaler',
|
'webapp/applications/apps_gcp_autoscaler',
|
||||||
'webapp/applications/apps_hpo'
|
'webapp/applications/apps_hpo',
|
||||||
|
'webapp/applications/apps_dashboard'
|
||||||
]
|
]
|
||||||
|
|
||||||
},
|
},
|
||||||
|
Loading…
Reference in New Issue
Block a user