From a3f1e2ccb3414fb91d0bde05331e68b268cd3c40 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 11 Jun 2023 12:28:44 +0300 Subject: [PATCH] Small edits (#592) --- docs/guides/pipeline/pipeline_decorator.md | 2 +- docs/webapp/applications/apps_dashboard.md | 2 +- docs/webapp/applications/apps_gpu_compute.md | 2 +- docs/webapp/webapp_overview.md | 26 ++++++++++---------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/guides/pipeline/pipeline_decorator.md b/docs/guides/pipeline/pipeline_decorator.md index b37591ee..fb0b4d0d 100644 --- a/docs/guides/pipeline/pipeline_decorator.md +++ b/docs/guides/pipeline/pipeline_decorator.md @@ -39,7 +39,7 @@ In the example script, the controller defines the interactions between the pipel :::info Local Execution In this example, the pipeline is set to run in local mode by using -the PipelineDecorator.run_locally +the PipelineDecorator.run_locally method before calling the pipeline function. See pipeline execution options [here](../../pipelines/pipelines_sdk_function_decorators.md#running-the-pipeline). ::: diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md index 97279c20..43addff1 100644 --- a/docs/webapp/applications/apps_dashboard.md +++ b/docs/webapp/applications/apps_dashboard.md @@ -27,7 +27,7 @@ of the chosen metric over time. * Monitored Metric - Title - Metric title to track * Monitored Metric - Series - Metric series (variant) to track * Monitored Metric - Trend - Choose whether to track the monitored metric's highest or lowest values -* Slack Notification (optional) - Set up Slack integration for notifications of task failure. Select the +* **Slack Notification** (optional) - Set up Slack integration for notifications of task failure. Select the `Alert on completed experiments` under `Additional options` to set up alerts for task completions. * API Token - Slack workspace access token * Channel Name - Slack channel to which task failure alerts will be posted diff --git a/docs/webapp/applications/apps_gpu_compute.md b/docs/webapp/applications/apps_gpu_compute.md index 57fa18aa..f1daedd1 100644 --- a/docs/webapp/applications/apps_gpu_compute.md +++ b/docs/webapp/applications/apps_gpu_compute.md @@ -37,7 +37,7 @@ For more information about how autoscalers work, see [Autoscalers Overview](../. * Git Password / Personal Access Token * **Cloud Storage Access** (optional) - Access credentials to cloud storage service. Provides ClearML Tasks running on cloud machines access to your storage -* Additional ClearML Configuration (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments +* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments ![GPU Compute wizard](../../img/apps_gpu_compute_wizard.png) diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 7a1b2e31..ee254d1f 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -15,34 +15,34 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform, The WebApp's sidebar provides access to the following modules: