From 78a54cc540dc035136e99d6001dcb31954e0fbc2 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 6 Dec 2022 11:39:14 +0200 Subject: [PATCH] Small edits (#401) --- docs/clearml_agent/clearml_agent_env_var.md | 28 +++++++++---------- docs/clearml_data/clearml_data.md | 10 +++---- docs/configs/env_vars.md | 24 ++++++++-------- docs/hyperdatasets/webapp/webapp_dataviews.md | 2 +- docs/release_notes/ver_1_8.md | 2 +- docs/webapp/webapp_model_table.md | 2 +- docusaurus.config.js | 2 +- 7 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/clearml_agent/clearml_agent_env_var.md b/docs/clearml_agent/clearml_agent_env_var.md index c9770771..58a6e1d3 100644 --- a/docs/clearml_agent/clearml_agent_env_var.md +++ b/docs/clearml_agent/clearml_agent_env_var.md @@ -17,20 +17,20 @@ but can be overridden by command-line arguments. |**CLEARML_CUDA_VERSION** | Sets the CUDA version to be used | |**CLEARML_CUDNN_VERSION** | Sets the CUDNN version to be used | |**CLEARML_CPU_ONLY** | Force CPU only mode | -|**CLEARML_DOCKER_SKIP_GPUS_FLAG**| Skips the GPUs flag (support for docker V18 | -|**CLEARML_AGENT_DOCKER_ARGS_HIDE_ENV**| Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable values will be replaced by `********`. See [`agent.hide_docker_command_env_vars`](../configs/clearml_conf.md#hide_docker) | -|**CLEARML_AGENT_DISABLE_SSH_MOUNT**| Disables the auto `.ssh` mount into the docker | +|**CLEARML_DOCKER_SKIP_GPUS_FLAG** | Skips the GPUs flag (support for docker V18 | +|**CLEARML_AGENT_DOCKER_ARGS_HIDE_ENV** | Hide Docker environment variables containing secrets when printing out the Docker command. When printed, the variable values will be replaced by `********`. See [`agent.hide_docker_command_env_vars`](../configs/clearml_conf.md#hide_docker) | +|**CLEARML_AGENT_DISABLE_SSH_MOUNT** | Disables the auto `.ssh` mount into the docker | |**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent | |**CLEARML_AGENT_GIT_PASS** | Sets the Git password for ClearML Agent | |**CLEARML_AGENT_GIT_HOST** | Sets Git host (only sending login to this host) | -|**CLEARML_AGENT_EXEC_USER**| User for Agent executing tasks (root by default) | -|**CLEARML_AGENT_EXTRA_DOCKER_ARGS**| Overrides extra docker args configuration | -|**CLEARML_AGENT_EXTRA_PYTHON_PATH**| Sets extra python path | -|**CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE**| Overrides initial server connection behavior (true by default), allows explicit number to specify number of connect retries) | -|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT**| Specifies Agent's mount point for Docker / K8s | -|**CLEARML_K8S_GLUE_START_AGENT_SCRIPT_PATH**| Provide an alternate path to place the agent startup script generated inside a k8s task pod (instead of the default `~/~/__start_agent__.sh`) | -|**CLEARML_AGENT_DEBUG_INFO**| Provide additional debug information for a specific context (currently only the `docker` value is supported) | -|**CLEARML_AGENT_CHILD_AGENTS_COUNT_CMD**| Provide an alternate bash command to list child agents while working in services mode | -|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL**| Skips Python virtual env installation on execute and provides a custom venv binary | -|**CLEARML_AGENT_SKIP_PYTHON_ENV_INSTALL**| Skips entire Python venv installation and assumes python as well as every dependency is preinstalled | -|**CLEARML_AGENT_VENV_CACHE_PATH**| Overrides venv cache folder configuration | \ No newline at end of file +|**CLEARML_AGENT_EXEC_USER** | User for Agent executing tasks (root by default) | +|**CLEARML_AGENT_EXTRA_DOCKER_ARGS** | Overrides extra docker args configuration | +|**CLEARML_AGENT_EXTRA_PYTHON_PATH** | Sets extra python path | +|**CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE** | Overrides initial server connection behavior (true by default), allows explicit number to specify number of connect retries) | +|**CLEARML_AGENT_K8S_HOST_MOUNT / CLEARML_AGENT_DOCKER_HOST_MOUNT** | Specifies Agent's mount point for Docker / K8s | +|**CLEARML_K8S_GLUE_START_AGENT_SCRIPT_PATH** | Provide an alternate path to place the agent startup script generated inside a k8s task pod (instead of the default `~/~/__start_agent__.sh`) | +|**CLEARML_AGENT_DEBUG_INFO** | Provide additional debug information for a specific context (currently only the `docker` value is supported) | +|**CLEARML_AGENT_CHILD_AGENTS_COUNT_CMD** | Provide an alternate bash command to list child agents while working in services mode | +|**CLEARML_AGENT_SKIP_PIP_VENV_INSTALL** | Skips Python virtual env installation on execute and provides a custom venv binary | +|**CLEARML_AGENT_SKIP_PYTHON_ENV_INSTALL** | Skips entire Python venv installation and assumes python as well as every dependency is preinstalled | +|**CLEARML_AGENT_VENV_CACHE_PATH** | Overrides venv cache folder configuration | \ No newline at end of file diff --git a/docs/clearml_data/clearml_data.md b/docs/clearml_data/clearml_data.md index 837c43c3..0189da4f 100644 --- a/docs/clearml_data/clearml_data.md +++ b/docs/clearml_data/clearml_data.md @@ -53,9 +53,9 @@ The following table displays the possible states for a dataset version. | State | Description | |---|---| -|*Uploading*| Dataset creation is in progress | -|*Failed*| Dataset creation was terminated with an error| -|*Aborted*| Dataset creation was aborted by user before it was finalization | -|*Final*| A dataset was created and finalized successfully | -|*Published*| The dataset is read-only. Publish a dataset to prevent changes to it | +|*Uploading* | Dataset creation is in progress | +|*Failed* | Dataset creation was terminated with an error| +|*Aborted* | Dataset creation was aborted by user before it was finalization | +|*Final* | A dataset was created and finalized successfully | +|*Published* | The dataset is read-only. Publish a dataset to prevent changes to it | diff --git a/docs/configs/env_vars.md b/docs/configs/env_vars.md index ea524679..b6f20006 100644 --- a/docs/configs/env_vars.md +++ b/docs/configs/env_vars.md @@ -21,33 +21,33 @@ but can be overridden by command-line arguments. |**CLEARML_DOCKER_IMAGE** | Sets the default docker image to run from | |**CLEARML_LOG_LEVEL** | debug / warning / error / info - Sets the ClearML package's log verbosity | |**CLEARML_SUPPRESS_UPDATE_MESSAGE** | Suppresses the message that notifies users of new ClearML package version | -|**CLEARML_DEFAULT_OUTPUT_URI**| The default output destination for model checkpoints (snapshots) and artifacts | -|**CLEARML_SET_ITERATION_OFFSET**| Initial iteration offset | +|**CLEARML_DEFAULT_OUTPUT_URI** | The default output destination for model checkpoints (snapshots) and artifacts | +|**CLEARML_SET_ITERATION_OFFSET** | Initial iteration offset | ### VCS Overrides Repository Auto-logging |Name| Description | |---|--------------------------------| -|**CLEARML_VCS_REPO_URL**| Repository's URL | -|**CLEARML_VCS_COMMIT_ID**| Repository's Commit ID | -|**CLEARML_VCS_BRANCH**| Repository's Branch | -|**CLEARML_VCS_ROOT**| Repository's Root directory | -|**CLEARML_VCS_WORK_DIR**| Repository's working directory | -|**CLEARML_VCS_STATUS**| Repository status | -|**CLEARML_VCS_DIFF**| Script diff | -|**CLEARML_VCS_ENTRY_POINT**| Entry point script | +|**CLEARML_VCS_REPO_URL** | Repository's URL | +|**CLEARML_VCS_COMMIT_ID** | Repository's Commit ID | +|**CLEARML_VCS_BRANCH** | Repository's Branch | +|**CLEARML_VCS_ROOT** | Repository's Root directory | +|**CLEARML_VCS_WORK_DIR** | Repository's working directory | +|**CLEARML_VCS_STATUS** | Repository status | +|**CLEARML_VCS_DIFF** | Script diff | +|**CLEARML_VCS_ENTRY_POINT** | Entry point script | ### Server Connection |Name|Description| |---|---| |**CLEARML_API_HOST** | Sets the API Server URL| -|**CLEARML_CONFIG_FILE**| Sets the ClearML configuration file. Overrides the default configuration file location| +|**CLEARML_CONFIG_FILE** | Sets the ClearML configuration file. Overrides the default configuration file location| |**CLEARML_WEB_HOST** | Sets the Web UI Server URL| |**CLEARML_FILES_HOST** | Sets the File Server URL| |**CLEARML_API_ACCESS_KEY** | Sets the Server's Public Access Key| |**CLEARML_API_SECRET_KEY** | Sets the Server's Private Access Key| -|**CLEARML_API_HOST_VERIFY_CERT**| Enables / Disables server certificate verification (if behind a firewall)| +|**CLEARML_API_HOST_VERIFY_CERT** | Enables / Disables server certificate verification (if behind a firewall)| |**CLEARML_OFFLINE_MODE** | Sets Offline mode| |**CLEARML_NO_DEFAULT_SERVER** | Disables sending information to demo server when no HOST server is set| diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index 45f942d5..0026eb1c 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -25,7 +25,7 @@ The Dataviews table includes the following columns: |**STATUS** | The status of the Dataview, which can be *Draft* (editable) or *Published* (read-only)| String| |**PROJECT** | The project name with which the dataview is associated| String| |**CREATED** | Elapsed time since the Dataview was created| Date-time| -|**DESCRIPTION**| A description of the Dataview | String| +|**DESCRIPTION** | A description of the Dataview | String| Dynamically order the columns by dragging a column heading to a new position. diff --git a/docs/release_notes/ver_1_8.md b/docs/release_notes/ver_1_8.md index cdd6de33..d6250cbe 100644 --- a/docs/release_notes/ver_1_8.md +++ b/docs/release_notes/ver_1_8.md @@ -4,7 +4,7 @@ title: Version 1.8 ### ClearML SDK 1.8.3 -**Bug fixes** +**Bug Fixes** * Set GCS credentials to `None` if invalid service account credentials are provided [ClearML GitHub issue #840](https://github.com/allegroai/clearml/issues/840) * Fix a sync issue when loading deferred configuration diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index fce722f1..f9e60873 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -28,7 +28,7 @@ The models table contains the following columns: | **TASK** | The experiment (Task) name that created the model. | String | | **UPDATED** | Elapsed time since the model was updated. Hover over the elapsed time to view the date and time.| Date-time | | **DESCRIPTION** | The model description (not shown by default). | String | -| *Metadata*| User defined metadata key column. Available options depend upon the models in the table. | String | +| *Metadata* | User defined metadata key column. Available options depend upon the models in the table. | String | ## Customizing the Models Table diff --git a/docusaurus.config.js b/docusaurus.config.js index eb97bf78..ad677435 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -135,7 +135,7 @@ module.exports = { items: [ { label: 'Slack', - href: 'https://join.slack.com/t/allegroai-trains/shared_invite/zt-c0t13pty-aVUZZW1TSSSg2vyIGVPBhg', + href: 'https://join.slack.com/t/clearml/shared_invite/zt-1kvcxu5hf-SRH_rmmHdLL7l2WadRJTQg', }, { label: 'Youtube',