From 865e46e5381880a690d23ff4e602932ef63189e2 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 19 May 2024 11:49:36 +0300 Subject: [PATCH] Small edits (#843) --- docs/clearml_agent/clearml_agent_env_var.md | 2 +- docs/configs/clearml_conf.md | 4 ++-- docs/configs/env_vars.md | 2 +- docs/remote_session.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/clearml_agent/clearml_agent_env_var.md b/docs/clearml_agent/clearml_agent_env_var.md index 200a732d..b14f79a6 100644 --- a/docs/clearml_agent/clearml_agent_env_var.md +++ b/docs/clearml_agent/clearml_agent_env_var.md @@ -4,7 +4,7 @@ title: ClearML Agent Environment Variables This page lists the available environment variables for configuring ClearML Agent. -In addition to the environment variables listed below, ClearML also supports dynamic environment variables to override +In addition to the environment variables listed below, ClearML also supports **dynamic environment variables** to override any configuration option that appears in the [`agent`](../configs/clearml_conf.md#agent-section) section of the `clearml.conf`. For more information, see [Dynamic Environment Variables](../clearml_agent.md#dynamic-environment-variables). diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index b3feab33..ed182290 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -976,7 +976,7 @@ and limitations on bucket naming. **`sdk.dataset.preview`** (*[dict]*) * Set limits for the objects that are logged as dataset previews: - * `**sdk.dataset.preview.media`** (*dict*) - Set limits for media files that are logged as dataset previews. Available + * **`sdk.dataset.preview.media`** (*dict*) - Set limits for media files that are logged as dataset previews. Available options: * **`sdk.dataset.preview.media.max_file_size`** (*int*) - Maximum file size in bytes of a preview object (e.g. image, video, html, etc.). Files exceeding this size will not be reported as previews. @@ -985,7 +985,7 @@ and limitations on bucket naming. * **`sdk.dataset.preview.media.audio_count`** (*int*) - The maximum number of image files reported as previews * **`sdk.dataset.preview.media.html_count`** (*int*) - The maximum number of html files reported as previews * **`sdk.dataset.preview.media.json_count`** (*int*) - The maximum number of json files reported as previews - * `**sdk.dataset.preview.tabular`** (*dict*) - Set limits for tabular files that are logged as dataset previews. Available + * **`sdk.dataset.preview.tabular`** (*dict*) - Set limits for tabular files that are logged as dataset previews. Available options: * **`sdk.dataset.preview.tabular.row_count`** (*int*) - The maximum number of rows for each tabular file reported as a preview. By default, it will report only the first 10 rows from a file * **`sdk.dataset.preview.tabular.table_count`** (*int*) - The maximum number of tables reported as preview in a dataset diff --git a/docs/configs/env_vars.md b/docs/configs/env_vars.md index a3b9c6b1..383dc131 100644 --- a/docs/configs/env_vars.md +++ b/docs/configs/env_vars.md @@ -4,7 +4,7 @@ title: Environment Variables This page lists the available environment variables for configuring ClearML. -In addition to the environment variables listed below, ClearML also supports dynamic environment variables to override +In addition to the environment variables listed below, ClearML also supports **dynamic environment variables** to override any configuration option that appears in the configuration files. For more information, see [Dynamic Environment Variables](../deploying_clearml/clearml_server_config.md#dynamic-environment-variables). :::info diff --git a/docs/remote_session.md b/docs/remote_session.md index 2be6599b..20f3a243 100644 --- a/docs/remote_session.md +++ b/docs/remote_session.md @@ -16,7 +16,7 @@ meets resource needs: * [Clearml Session CLI](apps/clearml_session.md) - Launch an interactive JupyterLab, VS Code, and SSH session on a remote machine: * Automatically store and sync your [interactive session workspace](apps/clearml_session.md#storing-and-synchronizing-workspace) * Replicate a previously executed experiment's execution environment and [interactively execute and debug](apps/clearml_session.md#starting-a-debugging-session) it on a remote session - * Develop directly inside your Kubernetes pods [see ClearML Agent](clearml_agent.md#kubernetes) + * Develop directly inside your Kubernetes pods ([see ClearML Agent](clearml_agent.md#kubernetes)) * And more! * GUI Applications (available under ClearML Enterprise Plan) - These apps provide local links to access JupyterLab or VS Code on a remote machine over a secure and encrypted SSH connection, letting you use the IDE as if you're running