diff --git a/clearml_agent/backend_api/config/default/agent.conf b/clearml_agent/backend_api/config/default/agent.conf index 94e0e0d..9941ee2 100644 --- a/clearml_agent/backend_api/config/default/agent.conf +++ b/clearml_agent/backend_api/config/default/agent.conf @@ -18,6 +18,8 @@ # https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html # git_user: "" # git_pass: "" + # Limit credentials to a single domain, for example: github.com, + # all other domains will use public access (no user/pass). Default: always send user/pass for any VCS domain # git_host: "" # Force GIT protocol to use SSH regardless of the git url (Assumes GIT user/pass are blank) @@ -75,7 +77,7 @@ force_upgrade: false, # additional artifact repositories to use when installing python packages - # extra_index_url: ["https://allegroai.jfrog.io/clearmlai/api/pypi/public/simple"] + # extra_index_url: ["https://allegroai.jfrog.io/clearml/api/pypi/public/simple"] # additional conda channels to use when installing with conda package manager conda_channels: ["pytorch", "conda-forge", "defaults", ] @@ -215,8 +217,8 @@ # default is True, report a single \r line in a sequence of consecutive lines, per 5 seconds. # suppress_carriage_return: true - # cuda versions used for solving pytorch wheel packages - # should be detected automatically. Override with os environment CUDA_VERSION / CUDNN_VERSION + # CUDA versions used for Conda setup & solving PyTorch wheel packages + # Should be detected automatically. Override with os environment CUDA_VERSION / CUDNN_VERSION # cuda_version: 10.1 # cudnn_version: 7.6 @@ -252,9 +254,9 @@ # Name docker containers created by the daemon using the following string format (supported from Docker 0.6.5) # Allowed variables are task_id, worker_id and rand_string (random lower-case letters string, up to 32 characters) - # Note: resulting name must start with an alphanumeric character and continue with alphanumeric characters, - # underscores (_), dots (.) and/or dashes (-) - #docker_container_name_format: "clearml-id-{task_id}-{rand_string:.8}" + # Note: resulting name must start with an alphanumeric character and + # continue with alphanumeric characters, underscores (_), dots (.) and/or dashes (-) + # docker_container_name_format: "clearml-id-{task_id}-{rand_string:.8}" # Apply top-level environment section from configuration into os.environ apply_environment: true diff --git a/clearml_agent/session.py b/clearml_agent/session.py index 88e92a7..6ca0b62 100644 --- a/clearml_agent/session.py +++ b/clearml_agent/session.py @@ -133,7 +133,7 @@ class Session(_Session): # override with environment variables # cuda_version & cudnn_version are overridden with os.environ here, and normalized in the next section for config_key, env_config in ENVIRONMENT_CONFIG.items(): - # check if the propery is of a list: + # check if the property is of a list: if config_key.endswith('.0'): if all(not i.get() for i in env_config.values()): continue diff --git a/docs/clearml.conf b/docs/clearml.conf index bdeb0e2..3a36e0c 100644 --- a/docs/clearml.conf +++ b/docs/clearml.conf @@ -13,6 +13,15 @@ api { } agent { + # unique name of this worker, if None, created based on hostname:process_id + # Override with os environment: CLEARML_WORKER_ID + # worker_id: "clearml-agent-machine1:gpu0" + worker_id: "" + + # worker name, replaces the hostname when creating a unique name for this worker + # Override with os environment: CLEARML_WORKER_NAME + # worker_name: "clearml-agent-machine1" + worker_name: "" # Set GIT user/pass credentials (if user/pass are set, GIT protocol will be set to https) # leave blank for GIT SSH credentials (set force_git_ssh_protocol=true to force SSH protocol) # **Notice**: GitHub personal token is equivalent to password, you can put it directly into `git_pass` @@ -20,11 +29,11 @@ agent { # https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token # https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/ # https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html - git_user="" - git_pass="" + # git_user: "" + # git_pass: "" # Limit credentials to a single domain, for example: github.com, # all other domains will use public access (no user/pass). Default: always send user/pass for any VCS domain - git_host="" + # git_host: "" # Force GIT protocol to use SSH regardless of the git url (Assumes GIT user/pass are blank) force_git_ssh_protocol: false @@ -33,16 +42,6 @@ agent { # Force a specific SSH username when converting http to ssh links (the default username is 'git') # force_git_ssh_user: git - # unique name of this worker, if None, created based on hostname:process_id - # Overridden with os environment: CLEARML_WORKER_ID - # worker_id: "clearml-agent-machine1:gpu0" - worker_id: "" - - # worker name, replaces the hostname when creating a unique name for this worker - # Overridden with os environment: CLEARML_WORKER_NAME - # worker_name: "clearml-agent-machine1" - worker_name: "" - # Set the python version to use when creating the virtual environment and launching the experiment # Example values: "/usr/bin/python3" or "/usr/local/bin/python3.6" # The default is the python executing the clearml_agent @@ -51,6 +50,22 @@ agent { # specific python version and the system supports multiple python the agent will use the requested python version) # ignore_requested_python_version: true + # Force the root folder of the git repository (instead of the working directory) into the PYHTONPATH + # default false, only the working directory will be added to the PYHTONPATH + # force_git_root_python_path: false + + # if set, use GIT_ASKPASS to pass user/pass when cloning / fetch repositories + # it solves passing user/token to git submodules. + # this is a safer way to ensure multiple users using the same repository will + # not accidentally leak credentials + # Only supported on Linux systems, it will be the default in future releases + # enable_git_ask_pass: false + + # in docker mode, if container's entrypoint automatically activated a virtual environment + # use the activated virtual environment and install everything there + # set to False to disable, and always create a new venv inheriting from the system_site_packages + # docker_use_activated_venv: true + # select python package manager: # currently supported: pip, conda and poetry # if "pip" or "conda" are used, the agent installs the required packages @@ -225,7 +240,7 @@ agent { enable_task_env: false # CUDA versions used for Conda setup & solving PyTorch wheel packages - # it Should be detected automatically. Override with os environment CUDA_VERSION / CUDNN_VERSION + # Should be detected automatically. Override with os environment CUDA_VERSION / CUDNN_VERSION # cuda_version: 10.1 # cudnn_version: 7.6