ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-03 12:51:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#401)

Browse Source
This commit is contained in:
pollfly 2022-12-06 11:39:14 +02:00 committed by GitHub
parent 1a07f8c617
commit 78a54cc540
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/clearml_agent/clearml_agent_env_var.md
View File

@ -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 |
|**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 |

10
docs/clearml_data/clearml_data.md
View File

@ -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 |

24
docs/configs/env_vars.md
View File

@ -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|

2
docs/hyperdatasets/webapp/webapp_dataviews.md
View File

@ -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.

2
docs/release_notes/ver_1_8.md
View File

@ -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

2
docs/webapp/webapp_model_table.md
View File

@ -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

2
docusaurus.config.js
View File

@ -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',