ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-31 15:49:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Monitor Project overview (#1051)
Some checks failed
CI / build (push) Has been cancelled
Details

Browse Source
This commit is contained in:
pollfly 2025-02-24 12:50:09 +02:00 committed by GitHub
parent dff09fa337
commit 7bda34ca90
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 44 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/getting_started/project_progress.md Normal file
View File

@ -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)

4
sidebars.js
View File

@ -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: [
{