mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Merge branch 'main' of https://github.com/allegroai/clearml-docs
This commit is contained in:
revital
commit
66cf5185e7
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).
|
||||
|
||||
|
||||
|
||||
41
docs/getting_started/task_trigger_schedule.md
Normal file
41
docs/getting_started/task_trigger_schedule.md
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Scheduling and Triggering Task Execution
|
||||
---
|
||||
|
||||
In ClearML, tasks can be scheduled and triggered automatically, enabling seamless workflow automation. This section
|
||||
provides an overview of the mechanisms available for managing task scheduling and event-based
|
||||
triggering.
|
||||
|
||||
## Task Scheduling
|
||||
Task scheduling allows users to define one-shot or periodic executions at specified times and intervals. This
|
||||
is useful for:
|
||||
|
||||
* Running routine operations such as periodic model training, evaluation jobs, backups, and reports.
|
||||
* Automating data ingestion and preprocessing workflows.
|
||||
* Ensuring regular execution of monitoring and reporting tasks.
|
||||
|
||||
ClearML's offers the following scheduling solutions:
|
||||
* [**UI Application**](../webapp/applications/apps_task_scheduler.md) (available under the Enterprise Plan) - The **Task Scheduler** app
|
||||
provides a simple no-code interface for managing task schedules.
|
||||
|
||||
* [**Python Interface**](../references/sdk/scheduler.md) - Use the `TaskScheduler` class to programmatically manage
|
||||
task schedules.
|
||||
|
||||
## Task Execution Triggering
|
||||
|
||||
ClearML's trigger manager enables you to automate task execution based on event occurence in the ClearML system, such as:
|
||||
* Changes in task status (e.g. running, completed, etc.)
|
||||
* Publication, archiving, or tagging of tasks, models, or datasets
|
||||
* Task metrics crossing predefined thresholds
|
||||
|
||||
This is useful for:
|
||||
* Triggering a training task when a dataset has been tagged as `latest` or any other tag
|
||||
* Running an inference task when a model has been published
|
||||
* Retraining a model when accuracy falls below a certain threshold
|
||||
* And more
|
||||
|
||||
ClearML's offers the following trigger management solutions:
|
||||
* [**UI Application**](../webapp/applications/apps_trigger_manager.md) (available under the Enterprise Plan) - The **Trigger Manager** app
|
||||
provides a simple no-code interface for managing task triggers .
|
||||
* [**Python Interface**](../references/sdk/trigger.md) - Use the `TriggerScheduler` class to programmatically manage
|
||||
task triggers.
|
||||
@ -95,13 +95,8 @@ module.exports = {
|
||||
{type: 'ref', id: 'webapp/applications/apps_gradio'},
|
||||
{type: 'ref', id: 'webapp/applications/apps_streamlit'},
|
||||
]},
|
||||
{"Automating Task Execution": [
|
||||
{type: 'ref', id: 'webapp/applications/apps_task_scheduler'},
|
||||
{type: 'ref', id: 'webapp/applications/apps_trigger_manager'},
|
||||
]},
|
||||
{"Monitoring Project Progress": [
|
||||
{type: 'ref', id: 'webapp/applications/apps_dashboard'},
|
||||
]},
|
||||
'getting_started/task_trigger_schedule',
|
||||
'getting_started/project_progress',
|
||||
],
|
||||
integrationsSidebar: [
|
||||
{
|
||||
|
||||
@ -46,7 +46,7 @@ html {
|
||||
--ifm-code-padding-vertical: 0.2rem;
|
||||
}
|
||||
|
||||
html[data-theme="dark"] {
|
||||
[data-theme=dark]:root {
|
||||
--ifm-background-color: #040506; /* body bg */
|
||||
--ifm-header-background-color: #101418; /* section 1 */
|
||||
--ifm-footer-background-color: #101418; /* section 1 */
|
||||
@ -54,12 +54,16 @@ html[data-theme="dark"] {
|
||||
--ifm-footer-link-hover-color: #ffffff; /* specific footer link hover color */
|
||||
--ifm-dropdown-background-color: #242D37; /* section 2 */
|
||||
--ifm-table-stripe-background: #101418; /* section 1 */
|
||||
--ifm-toc-background-color: #242D37; /* section 2 */
|
||||
--ifm-link-color: #6AD6C0; /* specific link color */
|
||||
--ifm-link-hover-color: #AEFDED; /* specific link hover color */
|
||||
--ifm-font-color-base: #E5E5E5 /* body text */
|
||||
--ifm-font-color-base: #E5E5E5; /* body text */
|
||||
--ifm-hr-background-color: #242D37; /* section 1 */
|
||||
--ifm-toc-link-color: #E5E5E5; /* body text */
|
||||
--ifm-toc-background-color: #242D37; /* section 2 */
|
||||
--ifm-code-background: #242D37; /* section 2 */
|
||||
}
|
||||
|
||||
|
||||
@media (min-width: 1400px) {
|
||||
/* Expand sidebar width above 1400px */
|
||||
html[data-theme="light"],
|
||||
@ -468,7 +472,6 @@ html[data-theme="light"] .table-of-contents {
|
||||
box-shadow: 0 0 0 2px rgba(0,0,0,0.1) inset;
|
||||
}
|
||||
html[data-theme="dark"] .table-of-contents {
|
||||
background-color: var(--ifm-toc-background-color);
|
||||
box-shadow: 0 0 0 2px rgba(0,0,0,0.4) inset;
|
||||
}
|
||||
html[data-theme="dark"] a.table-of-contents__link--active {
|
||||
@ -492,9 +495,6 @@ a.table-of-contents__link--active:before {
|
||||
border-left: 6px solid var(--ifm-color-primary);
|
||||
transform: translateY(5px);
|
||||
}
|
||||
html[data-theme="light"] .table-of-contents__link:not(.table-of-contents__link--active) {
|
||||
color: rgba(0,0,0,0.9);
|
||||
}
|
||||
|
||||
/* toc: show "..." inside code tag */
|
||||
.table-of-contents code {
|
||||
@ -785,16 +785,6 @@ html[data-theme="dark"] h4 a.hash-link {
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* <hr> */
|
||||
.markdown hr {
|
||||
border-bottom: none;
|
||||
}
|
||||
html[data-theme="dark"] .markdown hr {
|
||||
border-color: rgba(255,255,255,0.1);
|
||||
}
|
||||
|
||||
|
||||
/* admonition */
|
||||
.admonition {
|
||||
overflow: hidden;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user