diff --git a/docs/getting_started/building_bots.md b/docs/getting_started/building_bots.md deleted file mode 100644 index ef57b9b1..00000000 --- a/docs/getting_started/building_bots.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Building Bots ---- - -ClearML can be used to build bots that monitor tasks and send notifications based on specific events or conditions. - -The base [`Monitor`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py) class provides -the functionalities for implementing task monitoring logic. Developers can extend this class by inheriting it -and overriding its methods to introduce custom bot logic. - -For example, by overriding methods like [`process_task()`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py#L131), you can: -* Send notifications via Slack or other channels -* Log task statuses to a database -* Trigger automated responses when a task reaches a specific status - -This is useful for: -* Real-Time Task Monitoring: Automate the tracking of task statuses -* Custom Notification Logic: Implement specific filtering criteria based on task names, task projects, or other - criteria to receive relevant alerts. - -## SlackBot for ClearML Task Monitoring - -ClearML provides an example Slack bot built using [`clearml.automation.Monitor`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py). The bot does the following: - -* Monitors task status (completion, failure, etc.). -* Sends notifications to a specified Slack channel. -* Retrieves task details such as status, console logs, and links to the ClearML Web UI. - -You can configure filters for task types and projects to reduce unnecessary notifications. - -For a full example and detailed setup, see the [Slack Alerts Example](../guides/services/slack_alerts.md). - -![Slack Alerts](../img/examples_slack_alerts.png) \ No newline at end of file diff --git a/docs/getting_started/project_progress.md b/docs/getting_started/project_progress.md index 01f12893..9f2932d2 100644 --- a/docs/getting_started/project_progress.md +++ b/docs/getting_started/project_progress.md @@ -6,9 +6,22 @@ ClearML provides a comprehensive set of monitoring tools to help effectively tra These tools offer both high-level overviews and detailed insights into task execution, resource utilization, and project performance. -## Offerings -### Project Dashboard +## 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) + +## Project Dashboard :::info Pro Plan Offering The Project Dashboard app is available under the ClearML Pro plan. @@ -28,16 +41,24 @@ For more information, see [Project Dashboard](../webapp/applications/apps_dashbo ![Project Dashboard](../img/apps_dashboard.png#light-mode-only) ![Project Dashboard](../img/apps_dashboard_dark.png#dark-mode-only) -### Project Overview +## Slack Alerts -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. +ClearML allows you to monitor tasks and send notifications based on specific conditions or events using the [`clearml.automation.Monitor`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py) +class. By extending this class, you can: -Use the Metric Snapshot to track project progress and identify trends in task performance. +* Send notifications via Slack or other channels +* Trigger automated responses based on specific task conditions -For more information, see [Project Overview](../webapp/webapp_project_overview.md). +ClearML provides an example Slackbot built using the [`Monitor`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py) class. The Slackbot does the following: + +* Monitors task status (completion, failure, etc.) +* Sends notifications to a specified Slack channel +* Retrieves task details such as status, console logs, and links to the ClearML Web UI + +You can configure filters for task types and projects to reduce unnecessary notifications. + +For a full example and detailed setup, see the [Slack Alerts Example](../guides/services/slack_alerts.md). + +![Slack Alerts](../img/examples_slack_alerts.png#light-mode-only) +![Slack Alerts](../img/examples_slack_alerts_dark.png#dark-mode-only) -![Project Overview](../img/webapp_project_overview.png#light-mode-only) -![Project Overview](../img/webapp_project_overview_dark.png#dark-mode-only) diff --git a/docs/guides/services/slack_alerts.md b/docs/guides/services/slack_alerts.md index e7bcb251..2c80efed 100644 --- a/docs/guides/services/slack_alerts.md +++ b/docs/guides/services/slack_alerts.md @@ -6,11 +6,12 @@ The [Slack alerts example](https://github.com/clearml/clearml/blob/master/exampl demonstrates how to use the `clearml.automation.monitor` class to implement a service that monitors the completion and failure of tasks, and posts alert messages on a Slack channel. -![Slack alert example](../../img/examples_slack_alerts.png) +![Slack alert example](../../img/examples_slack_alerts.png#light-mode-only) +![Slack alert example](../../img/examples_slack_alerts_dark.png#dark-mode-only) -## Creating a Slack Bot +## Creating a Slackbot -Before configuring and running the Slack alert service, create a Slack Bot (**ClearML Bot**). +Before configuring and running the Slack alert service, create a Slackbot (**ClearML Bot**). :::important The Slack API token and channel you create are required to configure the Slack alert service. diff --git a/docs/img/examples_slack_alerts.png b/docs/img/examples_slack_alerts.png index 6c38d3b0..9bba329c 100644 Binary files a/docs/img/examples_slack_alerts.png and b/docs/img/examples_slack_alerts.png differ diff --git a/docs/img/examples_slack_alerts_dark.png b/docs/img/examples_slack_alerts_dark.png new file mode 100644 index 00000000..82026349 Binary files /dev/null and b/docs/img/examples_slack_alerts_dark.png differ diff --git a/sidebars.js b/sidebars.js index 074d1b0d..273533ad 100644 --- a/sidebars.js +++ b/sidebars.js @@ -64,7 +64,6 @@ module.exports = { 'getting_started/clearml_agent_docker_exec', 'getting_started/clearml_agent_base_docker', 'getting_started/clearml_agent_scheduling', - 'getting_started/building_bots', {"Deploying Model Endpoints": [ { type: 'category',