From 7bda34ca902b03ed1b3dbfb22e4877a737cef766 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Mon, 24 Feb 2025 12:50:09 +0200 Subject: [PATCH] Add Monitor Project overview (#1051) --- docs/getting_started/project_progress.md | 43 ++++++++++++++++++++++++ sidebars.js | 4 +-- 2 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 docs/getting_started/project_progress.md diff --git a/docs/getting_started/project_progress.md b/docs/getting_started/project_progress.md new file mode 100644 index 00000000..01f12893 --- /dev/null +++ b/docs/getting_started/project_progress.md @@ -0,0 +1,43 @@ +--- +title: Monitoring Project Progress +--- + +ClearML provides a comprehensive set of monitoring tools to help effectively track and manage machine learning projects. +These tools offer both high-level overviews and detailed insights into task execution, resource +utilization, and project performance. + +## Offerings + +### Project Dashboard + +:::info Pro Plan Offering +The Project Dashboard app is available under the ClearML Pro plan. +::: + +The [**Project Dashboard**](../webapp/applications/apps_dashboard.md) UI application provides a centralized +view of project progress, task statuses, resource usage, and key performance metrics. It offers: +* Comprehensive insights: + * Track task statuses and trends over time. + * Monitor GPU utilization and worker activity. + * Analyze performance metrics. +* Proactive alerts - By integrating with Slack, the Dashboard can notify teams of task failures + and completions. + +For more information, see [Project Dashboard](../webapp/applications/apps_dashboard.md). + +![Project Dashboard](../img/apps_dashboard.png#light-mode-only) +![Project Dashboard](../img/apps_dashboard_dark.png#dark-mode-only) + +### Project Overview + +A project's **OVERVIEW** tab in the UI presents a general picture of a project: +* Metric Snapshot – A graphical representation of selected metric values across project tasks, offering a quick assessment of progress. +* Task Status Tracking – When a single metric variant is selected for the snapshot, task status is color-coded (e.g., +Completed, Aborted, Published, Failed) for better visibility. + +Use the Metric Snapshot to track project progress and identify trends in task performance. + +For more information, see [Project Overview](../webapp/webapp_project_overview.md). + +![Project Overview](../img/webapp_project_overview.png#light-mode-only) +![Project Overview](../img/webapp_project_overview_dark.png#dark-mode-only) diff --git a/sidebars.js b/sidebars.js index c0179344..d1cdbb7f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -96,9 +96,7 @@ module.exports = { {type: 'ref', id: 'webapp/applications/apps_streamlit'}, ]}, 'getting_started/task_trigger_schedule', - {"Monitoring Project Progress": [ - {type: 'ref', id: 'webapp/applications/apps_dashboard'}, - ]}, + 'getting_started/project_progress', ], integrationsSidebar: [ {