From 03b2e7d7370f676493fde335d8de30d986c8adf2 Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Sun, 22 Sep 2024 13:20:13 +0300
Subject: [PATCH] Small edits (#936)
---
docs/configs/clearml_conf.md | 49 ++++++++++---------
docs/fundamentals/hpo.md | 2 +-
.../applications/apps_aws_autoscaler.md | 2 +-
docs/webapp/applications/apps_dashboard.md | 2 +-
.../applications/apps_gcp_autoscaler.md | 2 +-
docs/webapp/applications/apps_overview.md | 2 +-
docs/webapp/applications/apps_ssh_session.md | 8 +--
docs/webapp/webapp_workers_queues.md | 2 +-
8 files changed, 35 insertions(+), 34 deletions(-)
diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md
index b45b15d0..ec4ee66e 100644
--- a/docs/configs/clearml_conf.md
+++ b/docs/configs/clearml_conf.md
@@ -432,30 +432,31 @@ These settings define which Docker image and arguments should be used unless [ex
```
agent {
- default_docker {
- matche_rules [
- {
- image: "nvidia/cuda:10.1-cudnn7-runtime-ubuntu18.04"
- arguments: "-e define=value"
- match: {
- script {
- # Optional: must match all requirements (not partial)
- requirements: {
- # version selection matching PEP-440
- pip: {
- tensorflow: "~=2.6"
- },
- # Optional: matching based on regular expression, example: "^exact_match$"
- repository: "/my_repository/"
- branch: "main"
- binary: "python3.6"
- }
- # Optional: matching based on regular expression, example: "^exact_match$"
- project: "project/sub_project"
- }
- }
- ]
- }
+ default_docker {
+ matche_rules [
+ {
+ image: "nvidia/cuda:10.1-cudnn7-runtime-ubuntu18.04"
+ arguments: "-e define=value"
+ match: {
+ script {
+ # Optional: must match all requirements (not partial)
+ requirements: {
+ # version selection matching PEP-440
+ pip: {
+ tensorflow: "~=2.6"
+ },
+ }
+ # Optional: matching based on regular expression, example: "^exact_match$"
+ repository: "/my_repository/"
+ branch: "main"
+ binary: "python3.6"
+ }
+ # Optional: matching based on regular expression, example: "^exact_match$"
+ project: "project/sub_project"
+ }
+ }
+ ]
+ }
}
```
diff --git a/docs/fundamentals/hpo.md b/docs/fundamentals/hpo.md
index 8a5a8521..0640ab50 100644
--- a/docs/fundamentals/hpo.md
+++ b/docs/fundamentals/hpo.md
@@ -161,7 +161,7 @@ ClearML also provides `clearml-param-search`, a CLI utility for managing the hyp
## UI Application
:::info Pro Plan Offering
-The ClearML HPO App is available under the ClearML Pro plan
+The ClearML HPO App is available under the ClearML Pro plan.
:::
ClearML provides the [Hyperparameter Optimization GUI application](../webapp/applications/apps_hpo.md) for launching and
diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md
index 0a5116cf..ca69e3cf 100644
--- a/docs/webapp/applications/apps_aws_autoscaler.md
+++ b/docs/webapp/applications/apps_aws_autoscaler.md
@@ -3,7 +3,7 @@ title: AWS Autoscaler
---
:::info Pro Plan Offering
-The ClearML AWS Autoscaler App is available under the ClearML Pro plan
+The ClearML AWS Autoscaler App is available under the ClearML Pro plan.
:::
The AWS Autoscaler Application optimizes AWS EC2 instance usage according to a user defined resource budget: define your
diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md
index 26fdd5bc..abb7d05d 100644
--- a/docs/webapp/applications/apps_dashboard.md
+++ b/docs/webapp/applications/apps_dashboard.md
@@ -3,7 +3,7 @@ title: Project Dashboard
---
:::info Pro Plan Offering
-The ClearML Project Dashboard App is available under the ClearML Pro plan
+The ClearML Project Dashboard App is available under the ClearML Pro plan.
:::
The Project Dashboard Application provides an overview of a project's or workspace's progress. It presents an aggregated
diff --git a/docs/webapp/applications/apps_gcp_autoscaler.md b/docs/webapp/applications/apps_gcp_autoscaler.md
index b642cf6a..8d1be643 100644
--- a/docs/webapp/applications/apps_gcp_autoscaler.md
+++ b/docs/webapp/applications/apps_gcp_autoscaler.md
@@ -3,7 +3,7 @@ title: GCP Autoscaler
---
:::info Pro Plan Offering
-The ClearML GCP Autoscaler App is available under the ClearML Pro plan
+The ClearML GCP Autoscaler App is available under the ClearML Pro plan.
:::
The GCP Autoscaler Application optimizes GCP VM instance usage according to a user defined instance budget: Define your
diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md
index de26f8d8..43a414b4 100644
--- a/docs/webapp/applications/apps_overview.md
+++ b/docs/webapp/applications/apps_overview.md
@@ -3,7 +3,7 @@ title: Overview
---
:::info Pro Plan Offering
-ClearML Applications are available under the ClearML Pro plan
+ClearML Applications are available under the ClearML Pro plan.
:::
Use ClearML's GUI Applications to manage ML workloads and automatically run your recurring workflows without any coding.
diff --git a/docs/webapp/applications/apps_ssh_session.md b/docs/webapp/applications/apps_ssh_session.md
index 44b3ccf4..9f385c30 100644
--- a/docs/webapp/applications/apps_ssh_session.md
+++ b/docs/webapp/applications/apps_ssh_session.md
@@ -21,10 +21,10 @@ The application monitors the session's activity and shuts down if it is inactive
Once you have launched an app instance, you can view the following information in its dashboard:
* App status indicator
- * - Remote SSH session is setting up
- * - Remote SSH session is active
- * - Remote SSH session is idle
- * - Remote SSH session is stopped
+ * - Remote SSH session is setting up
+ * - Remote SSH session is active
+ * - Remote SSH session is idle
+ * - Remote SSH session is stopped
* Idle time
* Restored workspace - If a previous session’s workspace was restored, this will display its session ID
* Current session ID
diff --git a/docs/webapp/webapp_workers_queues.md b/docs/webapp/webapp_workers_queues.md
index d1f33a6e..da7db73e 100644
--- a/docs/webapp/webapp_workers_queues.md
+++ b/docs/webapp/webapp_workers_queues.md
@@ -21,7 +21,7 @@ in the ClearML Enterprise plan. See [Resource Policies](resource_policies.md))
## Autoscalers
:::info Pro Plan Offering
-The ClearML Autoscaler apps are available under the ClearML Pro plan
+The ClearML Autoscaler apps are available under the ClearML Pro plan.
:::
Use the **AUTOSCALERS** tab to access ClearML's cloud autoscaling applications: