From 1a979a521e14e2c84fdadaa3e0743092140f3d47 Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Wed, 5 Mar 2025 16:39:16 +0200
Subject: [PATCH] Clarify Non-responsive Task Watchdog section (#1072)

---
 .../clearml_server_config.md                  | 28 +++++++++++--------
 1 file changed, 17 insertions(+), 11 deletions(-)

diff --git a/docs/deploying_clearml/clearml_server_config.md b/docs/deploying_clearml/clearml_server_config.md
index 014161cc..09b4e835 100644
--- a/docs/deploying_clearml/clearml_server_config.md
+++ b/docs/deploying_clearml/clearml_server_config.md
@@ -361,10 +361,16 @@ You can also use hashed passwords instead of plain-text passwords. To do that:
 
 ### Non-responsive Task Watchdog
 
-The non-responsive task watchdog monitors tasks that were not updated for a specified time interval, and then 
-the watchdog marks them as `aborted`. The non-responsive experiment watchdog is always active.
+The non-responsive task watchdog monitors for running tasks that have stopped communicating with the ClearML Server for a specified 
+time interval. If a task remains unresponsive beyond the set threshold, the watchdog marks it as `aborted`. 
 
-Modify the following settings for the watchdog:
+A task is considered non-responsive if the time since its last communication with the ClearML Server exceeds the 
+configured threshold. The watchdog starts counting after each successful communication with the server. If no further 
+updates are received within the specified time, the task is considered non-responsive. This typically happens if:
+* The task's main process is stuck but has not exited.
+* There is a network issue preventing the task from communicating with the server.
+
+You can configure the following watchdog settings:
 
 * Watchdog status - enabled / disabled
 * The time threshold (in seconds) of experiment inactivity (default value is 7200 seconds (2 hours)).
@@ -372,10 +378,15 @@ Modify the following settings for the watchdog:
  
 **To configure the non-responsive watchdog for the ClearML Server:**
 
-1. In the ClearML Server `/opt/clearml/config/services.conf` file, add or edit the `tasks.non_responsive_tasks_watchdog` 
-   section and specify the watchdog settings.
+1. Open the ClearML Server `/opt/clearml/config/services.conf` file.
+   
+   :::tip
+   If the `services.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or 
+   an alternate folder you configured).
+   :::
+
+1. Add or edit the `tasks.non_responsive_tasks_watchdog` section and specify the watchdog settings. For example:
 
-    For example:
     ```
     tasks {
         non_responsive_tasks_watchdog {
@@ -389,11 +400,6 @@ Modify the following settings for the watchdog:
         }
     }
    ```
-   
-   :::tip
-   If the `services.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or 
-   an alternate folder you configured), and input the modified configuration
-   :::
         
 1. Restart ClearML Server.