mirror of
https://github.com/clearml/clearml-docs
synced 2025-02-24 21:14:37 +00:00
Add Monitor Project overview (#1051)
Some checks are pending
CI / build (push) Waiting to run
Some checks are pending
CI / build (push) Waiting to run
This commit is contained in:
parent
dff09fa337
commit
7bda34ca90
43
docs/getting_started/project_progress.md
Normal file
43
docs/getting_started/project_progress.md
Normal 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 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).
|
||||
|
||||

|
||||

|
@ -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: [
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user