diff --git a/docs/getting_started/building_bots.md b/docs/getting_started/building_bots.md index 87725637..b15af790 100644 --- a/docs/getting_started/building_bots.md +++ b/docs/getting_started/building_bots.md @@ -2,6 +2,24 @@ title: Building Bots --- +You can use ClearML to build bots monitor tasks, sending notifications and alerts based on specific events or conditions. + +The base `Monitor` class provides essential functionalities that enable developers to implement task monitoring logic +tailored to their requirements. The Monitor class can be extended to create custom bot logic. + +This is useful for: +* Real-Time Task Monitoring: Automate the tracking of task statuses (e.g., completed, failed) to streamline workflows + and reduce manual log-checking. +* Custom Notification Logic: Implement specific filtering criteria based on task names, project identifiers, or other + criteria to receive alerts that are relevant to your needs. +* Resource Efficiency: Utilize a customizable polling mechanism to minimize resource usage while continuously monitoring + tasks. + +The Monitor class can be extended to introduce custom bot logic. For example, by overriding the `process_task` method, you +can define specific actions to be taken when a task reaches a certain status—whether it’s sending notifications through +various channels (like Slack, email, etc.), logging to a database, or triggering automated responses. + + Using a Slack Bot for ClearML Task Monitoring Overview @@ -21,7 +39,7 @@ Use Cases and Benefits Set filters for specific projects, users, or iteration thresholds to avoid unnecessary notifications. -## ClearML Integration +## SlackBot example This integration is powered by `clearml.automation.monitor`, which allows for efficient task tracking. The `SlackMonitor` class extends the Monitor class from ClearML and enables customized Slack notifications based on task events. The bot diff --git a/sidebars.js b/sidebars.js index 273533ad..074d1b0d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -64,6 +64,7 @@ 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',