From 77e760bfa0f9a2d2dab15953d80c487c6467e586 Mon Sep 17 00:00:00 2001 From: revital Date: Tue, 3 Jun 2025 07:36:54 +0300 Subject: [PATCH 1/2] Small edits --- .../enterprise_deploy/appgw_install_k8s.md | 6 +++--- .../enterprise_deploy/extra_configs/gpu_operator.md | 2 +- .../enterprise_deploy/fractional_gpus/cfgi.md | 2 +- docs/deploying_clearml/enterprise_deploy/k8s.md | 12 ++++++------ .../enterprise_deploy/multi_tenant_k8s.md | 2 +- docs/guides/clearml-task/clearml_task_tutorial.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 9f145159..95af495a 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -34,7 +34,7 @@ It can only configure access for ClearML Tasks within its own namespace. ### Login -``` bash +```bash helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username --password ``` @@ -80,7 +80,7 @@ tcpSession: The full list of supported configuration is available with the command: -``` bash +```bash helm show readme clearml-enterprise/clearml-enterprise-app-gateway ``` @@ -88,7 +88,7 @@ helm show readme clearml-enterprise/clearml-enterprise-app-gateway To install the App Gateway component via Helm use the following command: -``` bash +```bash helm upgrade --install -n clearml-enterprise/clearml-enterprise-app-gateway --version -f clearml-app-gateway-values.override.yaml ``` diff --git a/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md b/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md index 042418bf..28d1eb51 100644 --- a/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md +++ b/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md @@ -47,7 +47,7 @@ devicePlugin: Install the `gpu-operator`: -``` bash +```bash helm install -n gpu-operator gpu-operator nvidia/gpu-operator --create-namespace -f gpu-operator.override.yaml ``` diff --git a/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md b/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md index cc28aef6..b201b98a 100644 --- a/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md +++ b/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md @@ -203,7 +203,7 @@ This label is used by the CFGI to assign the correct portion of GPU resources to Starting from version 1.3.0, there is no need to specify the resources field. You only need to set the labels: -``` yaml +```yaml agentk8sglue: createQueues: true queues: diff --git a/docs/deploying_clearml/enterprise_deploy/k8s.md b/docs/deploying_clearml/enterprise_deploy/k8s.md index f56956dc..01fc0a93 100644 --- a/docs/deploying_clearml/enterprise_deploy/k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/k8s.md @@ -46,12 +46,12 @@ For optimal performance, a Kubernetes cluster with at least 3 nodes is recommend Add the ClearML Helm repository: -``` bash +```bash helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username --password ``` Update the local repository: -``` bash +```bash helm repo update ``` @@ -64,7 +64,7 @@ In the following configuration, replace the `` placeholders with a pointing to the cluster's Ingress Controller. This will be the base domain for reaching your ClearML installation. ::: -``` yaml +```yaml imageCredentials: password: "" clearml: @@ -126,7 +126,7 @@ Kubernetes. If you need to define your own credentials to be used instead, replace the default key and secret values in `clearml-values.override.yaml`. -``` yaml +```yaml clearml: # Replace the following values to use custom internal credentials. apiserverKey: "" @@ -140,7 +140,7 @@ clearml: In a shell, if `openssl` is installed, you can use this simple command to generate random strings suitable as keys and secrets: -``` bash +```bash openssl rand -hex 16 ``` @@ -151,7 +151,7 @@ installations. This is an optional step in case the SSO (Identity provider) conf Please note that this setup is not ideal for multi-tenant setups as fixed users will only be associated with the default tenant. -``` yaml +```yaml apiserver: additionalConfigs: apiserver.conf: | diff --git a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md index f498e09e..b80c196d 100644 --- a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md @@ -287,7 +287,7 @@ For each group you define in the configuration, you need to specify the followin | `name` | Display name for the group (should match `` used in the variable path) | `CLEARML__services__auth__default_groups____name` | `"My Group Name"`, `"MLOps Team"` | | `features` | JSON list of features to enable for this group . For the complete list of available features, see [Available Features](#available-features). Note that the features must be defined for the tenant or for the entire server in order to affect the group. By default, all the features of the tenant are available to all users. | `CLEARML__services__auth__default_groups____features` | `'["applications", "experiments", "pipelines", "reports", "show_dashboard", "show_projects"]'` (Note the single quotes wrapping the JSON string if setting via YAML/environment variables). | | `assignable` | Whether admins can assign users to this group from the ClearML Web UI (`true`/`false`). If `false`, group membership is managed externally or implicitly. | `CLEARML__services__auth__default_groups____assignable` | `"false"` | -| `system` | Always set to `"false"` for custom groups | ``CLEARML__services__auth__default_groups____system` | `"false"` | +| `system` | Always set to `"false"` for custom groups | `CLEARML__services__auth__default_groups____system` | `"false"` | ##### Example Configuration diff --git a/docs/guides/clearml-task/clearml_task_tutorial.md b/docs/guides/clearml-task/clearml_task_tutorial.md index 39346bab..8729d27c 100644 --- a/docs/guides/clearml-task/clearml_task_tutorial.md +++ b/docs/guides/clearml-task/clearml_task_tutorial.md @@ -12,7 +12,7 @@ on a remote or local machine, from a remote repository and your local machine. ### Executing Code from a Remote Repository -``` bash +```bash clearml-task --project keras_examples --name remote_test --repo https://github.com/clearml/events.git --branch master --script /webinar-0620/keras_mnist.py --args batch_size=64 epochs=1 --queue default ``` From 4322b78fe392407af4a28430f434c88906a23432 Mon Sep 17 00:00:00 2001 From: revital Date: Tue, 3 Jun 2025 07:36:54 +0300 Subject: [PATCH 2/2] Small edits --- .../enterprise_deploy/appgw_install_k8s.md | 6 +++--- .../enterprise_deploy/extra_configs/gpu_operator.md | 2 +- .../enterprise_deploy/fractional_gpus/cfgi.md | 2 +- docs/deploying_clearml/enterprise_deploy/k8s.md | 12 ++++++------ .../enterprise_deploy/multi_tenant_k8s.md | 4 ++-- docs/guides/clearml-task/clearml_task_tutorial.md | 2 +- docs/webapp/webapp_exp_track_visual.md | 2 +- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 9f145159..95af495a 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -34,7 +34,7 @@ It can only configure access for ClearML Tasks within its own namespace. ### Login -``` bash +```bash helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username --password ``` @@ -80,7 +80,7 @@ tcpSession: The full list of supported configuration is available with the command: -``` bash +```bash helm show readme clearml-enterprise/clearml-enterprise-app-gateway ``` @@ -88,7 +88,7 @@ helm show readme clearml-enterprise/clearml-enterprise-app-gateway To install the App Gateway component via Helm use the following command: -``` bash +```bash helm upgrade --install -n clearml-enterprise/clearml-enterprise-app-gateway --version -f clearml-app-gateway-values.override.yaml ``` diff --git a/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md b/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md index 042418bf..28d1eb51 100644 --- a/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md +++ b/docs/deploying_clearml/enterprise_deploy/extra_configs/gpu_operator.md @@ -47,7 +47,7 @@ devicePlugin: Install the `gpu-operator`: -``` bash +```bash helm install -n gpu-operator gpu-operator nvidia/gpu-operator --create-namespace -f gpu-operator.override.yaml ``` diff --git a/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md b/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md index cc28aef6..b201b98a 100644 --- a/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md +++ b/docs/deploying_clearml/enterprise_deploy/fractional_gpus/cfgi.md @@ -203,7 +203,7 @@ This label is used by the CFGI to assign the correct portion of GPU resources to Starting from version 1.3.0, there is no need to specify the resources field. You only need to set the labels: -``` yaml +```yaml agentk8sglue: createQueues: true queues: diff --git a/docs/deploying_clearml/enterprise_deploy/k8s.md b/docs/deploying_clearml/enterprise_deploy/k8s.md index f56956dc..01fc0a93 100644 --- a/docs/deploying_clearml/enterprise_deploy/k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/k8s.md @@ -46,12 +46,12 @@ For optimal performance, a Kubernetes cluster with at least 3 nodes is recommend Add the ClearML Helm repository: -``` bash +```bash helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username --password ``` Update the local repository: -``` bash +```bash helm repo update ``` @@ -64,7 +64,7 @@ In the following configuration, replace the `` placeholders with a pointing to the cluster's Ingress Controller. This will be the base domain for reaching your ClearML installation. ::: -``` yaml +```yaml imageCredentials: password: "" clearml: @@ -126,7 +126,7 @@ Kubernetes. If you need to define your own credentials to be used instead, replace the default key and secret values in `clearml-values.override.yaml`. -``` yaml +```yaml clearml: # Replace the following values to use custom internal credentials. apiserverKey: "" @@ -140,7 +140,7 @@ clearml: In a shell, if `openssl` is installed, you can use this simple command to generate random strings suitable as keys and secrets: -``` bash +```bash openssl rand -hex 16 ``` @@ -151,7 +151,7 @@ installations. This is an optional step in case the SSO (Identity provider) conf Please note that this setup is not ideal for multi-tenant setups as fixed users will only be associated with the default tenant. -``` yaml +```yaml apiserver: additionalConfigs: apiserver.conf: | diff --git a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md index f498e09e..4eea5d79 100644 --- a/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/multi_tenant_k8s.md @@ -287,7 +287,7 @@ For each group you define in the configuration, you need to specify the followin | `name` | Display name for the group (should match `` used in the variable path) | `CLEARML__services__auth__default_groups____name` | `"My Group Name"`, `"MLOps Team"` | | `features` | JSON list of features to enable for this group . For the complete list of available features, see [Available Features](#available-features). Note that the features must be defined for the tenant or for the entire server in order to affect the group. By default, all the features of the tenant are available to all users. | `CLEARML__services__auth__default_groups____features` | `'["applications", "experiments", "pipelines", "reports", "show_dashboard", "show_projects"]'` (Note the single quotes wrapping the JSON string if setting via YAML/environment variables). | | `assignable` | Whether admins can assign users to this group from the ClearML Web UI (`true`/`false`). If `false`, group membership is managed externally or implicitly. | `CLEARML__services__auth__default_groups____assignable` | `"false"` | -| `system` | Always set to `"false"` for custom groups | ``CLEARML__services__auth__default_groups____system` | `"false"` | +| `system` | Always set to `"false"` for custom groups | `CLEARML__services__auth__default_groups____system` | `"false"` | ##### Example Configuration @@ -475,7 +475,7 @@ The following features can be assigned to groups via the `features` configuratio | `sso_management` | Enables the SSO (Single Sign-On) configuration wizard. | No | | `service_users` | Enables support for creating and managing service accounts (API keys). | No | | `resource_policy` | Enables the [Resource Policies](../../webapp/resource_policies.md) feature. | May default to a trial feature if not explicitly enabled. | -| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endoints.md) feature. | No | +| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endpoints.md) feature. | No | | `show_dashboard` | Makes the "Dashboard" menu item visible in the UI sidebar. | No | | `show_model_view` | Makes the "Models" menu item visible in the UI sidebar. | No | | `show_projects` | Makes the "Projects" menu item visible in the UI sidebar. | No | diff --git a/docs/guides/clearml-task/clearml_task_tutorial.md b/docs/guides/clearml-task/clearml_task_tutorial.md index 39346bab..8729d27c 100644 --- a/docs/guides/clearml-task/clearml_task_tutorial.md +++ b/docs/guides/clearml-task/clearml_task_tutorial.md @@ -12,7 +12,7 @@ on a remote or local machine, from a remote repository and your local machine. ### Executing Code from a Remote Repository -``` bash +```bash clearml-task --project keras_examples --name remote_test --repo https://github.com/clearml/events.git --branch master --script /webinar-0620/keras_mnist.py --args batch_size=64 epochs=1 --queue default ``` diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 36278e86..b81a7daf 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -309,7 +309,7 @@ Scalar graph view (Graph shows scalar series plotted as a time series line chart. By default, a single plot is shown for each scalar metric, with all variants overlaid within. -The series are sub-sampled for +The series are subsampled for display efficiency. For high resolution, view a series in full screen mode by hovering over the graph and clicking <img src=. :::info Full Screen Refresh