diff --git a/docs/fundamentals/task.md b/docs/fundamentals/task.md index 804905ac..11003862 100644 --- a/docs/fundamentals/task.md +++ b/docs/fundamentals/task.md @@ -205,6 +205,33 @@ task = Task.create( See [`Task.create`](../references/sdk/task.md#taskcreate) in the Python SDK reference. +### Tracking Task Progress +Track a task’s progress by setting the task progress property using the [`Task.set_progress`](../references/sdk/task.md#set_progress) method. +Set a task’s progress to a numeric value between 0 - 100. Access the task’s current progress, using the +[`Task.get_progress`](../references/sdk/task.md#get_progress) method. + +```python +task = Task.init(project_name="examples", task_name="Track experiment progress") +task.set_progress(0) +# task doing stuff +task.set_progress(50) +print(task.get_progress()) +# task doing more stuff +task.set_progress(100) +``` + +While the task is running, the WebApp will show the task’s progress indication in the experiment table, next to the +task’s status. If a task failed or was aborted, you can view how much progress it had made. + +
+ +![Experiment table progress indication](../img/fundamentals_task_progress.png) + +
+ +Additionally, you can view a task’s progress in its [INFO](../webapp/webapp_exp_track_visual.md#general-information) tab +in the WebApp. + ### Accessing Tasks A Task can be identified by its project and name, and by a unique identifier (UUID string). The name and project of a Task can be changed after an experiment has been executed, but its ID can't be changed. diff --git a/docs/img/fundamentals_task_progress.png b/docs/img/fundamentals_task_progress.png new file mode 100644 index 00000000..0a2894a4 Binary files /dev/null and b/docs/img/fundamentals_task_progress.png differ diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md index f191e2e2..cef7bbaa 100644 --- a/docs/webapp/webapp_exp_table.md +++ b/docs/webapp/webapp_exp_table.md @@ -28,7 +28,7 @@ The experiments table default and customizable columns are described in the foll | **TYPE** | Type of experiment. ClearML supports multiple [task types](../fundamentals/task.md#task-types) for experimentation, and a variety of workflows and use cases. | Default | | **NAME** | Experiment name. | Default | | **TAGS** | Descriptive, user-defined, color-coded tags assigned to experiments. Use tags to classify experiments, and filter the list. See [tagging experiments](webapp_exp_track_visual.md#tagging-experiments). | Default | -| **STATUS** | Experiment state (status). See a list of the [task states and state transitions](../fundamentals/task.md#task-states). | Default | +| **STATUS** | Experiment state (status). See a list of the [task states and state transitions](../fundamentals/task.md#task-states). If you programmatically set task progress values, you will also see a progress indicator for Running, Failed, and Aborted tasks. See [here](../fundamentals/task.md#tracking-task-progress). | Default | | **PROJECT** | Name of experiment's project. | Default | | **USER** | User who created or cloned the experiment. | Default (hidden) | | **STARTED** | Elapsed time since the experiment started. To view the date and time of start, hover over the elapsed time. | Default | diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 3bf77135..fa5026fe 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -231,6 +231,8 @@ General experiment details appear in the **INFO** tab. This includes information * Host name * Processor * Python version +* Experiment Progress + ![Info tab](../img/webapp_tracking_31.png)