diff --git a/docs/img/apps_dashboard.png b/docs/img/apps_dashboard.png new file mode 100644 index 00000000..fba2623b Binary files /dev/null and b/docs/img/apps_dashboard.png differ diff --git a/docs/img/apps_dashboard_wizard.png b/docs/img/apps_dashboard_wizard.png new file mode 100644 index 00000000..32971491 Binary files /dev/null and b/docs/img/apps_dashboard_wizard.png differ diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md new file mode 100644 index 00000000..759e9e17 --- /dev/null +++ b/docs/webapp/applications/apps_dashboard.md @@ -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) diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md index 60260863..023bdd09 100644 --- a/docs/webapp/applications/apps_overview.md +++ b/docs/webapp/applications/apps_overview.md @@ -15,9 +15,9 @@ Configure and launch app instances, then track their execution from the app dash ClearML provides the following applications: * [**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 -* [**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 -* **Project Dashboard** - High-level project monitoring with Slack alerts +* [**Project Dashboard**](apps_dashboard.md) - High-level project monitoring with Slack alerts ## App Pages Layout Each application’s page is split into two sections: diff --git a/sidebars.js b/sidebars.js index 26139957..3323931a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -60,7 +60,8 @@ module.exports = { 'webapp/applications/apps_overview', 'webapp/applications/apps_aws_autoscaler', 'webapp/applications/apps_gcp_autoscaler', - 'webapp/applications/apps_hpo' + 'webapp/applications/apps_hpo', + 'webapp/applications/apps_dashboard' ] },