Configuring ClearML for Your ClearML Server
important
This documentation page applies to deploying your own open source ClearML Server. It does not apply to ClearML Hosted Service users.
The ClearML configuration file that will be initialized will contain the host URLs of the ClearML Server, and ClearML credentials, allowing the code to integrate with the server. Later, ClearML can be tailored to fit requirements by setting configuration options.
To configure ClearML for your ClearML Server:
If not installed already, install
clearml
(see install)In a terminal session, run the ClearML setup wizard.
Learn about creating multiple ClearML configuration files
Additional ClearML configuration files can be created, for example, to use inside Docker containers when executing a Task.
Use the
--file
option forclearml-init
.and then specify it using the
CLEARML_CONFIG_FILE
environment variable inside the container:For more information about running experiments inside Docker containers, see ClearML Agent Execution and ClearML Agent Reference.
If the setup wizard's response indicates that a configuration file already exists, follow the instructions in here. The wizard does not edit or overwrite existing configuration files.
The setup wizard prompts for ClearML credentials.
Get ClearML credentials. Open the ClearML Web UI in a browser. On the SETTINGS > WORKSPACE page, click Create new credentials > Copy to clipboard.
At the command prompt
Paste copied configuration here:
, copy and paste the ClearML credentials.The setup wizard confirms the credentials.
Enter the ClearML Server web server URL, or press Enter to accept the default which is detected from the credentials.
Enter the ClearML Server API server URL, or press Enter to accept the default value which is based on the previous response:
Enter the ClearML Server file server URL, or press Enter to accept the default value which is based on the previous response:
The wizard responds with a configuration and directs to the ClearML Server.
The configuration file's location depends upon the operating system:
- Linux -
~/clearml.conf
- Mac -
$HOME/clearml.conf
- Windows -
\User\<username>\clearml.conf
#
Add ClearML to a Configuration FileThe setup wizard may indicate that a configuration file already exists. For example, if a ClearML Agent was previously configured, then a configuration file was created. The wizard does not edit or overwrite existing configuration files.
The host URLs for the ClearML Server are required:
- ClearML Server web server
- ClearML Server API server
- ClearML Server file server
These may be localhost, the domain, or a sub-domain of the domain.
To add ClearML settings to an existing ClearML configuration file:
Open the ClearML configuration file for editing. Depending upon the operating system, it is:
- Linux -
~/clearml.conf
- macOS -
$HOME/clearml.conf
- Windows -
\User\<username>\clearml.conf
- Linux -
In the
sdk.development
section, add the logging of environment variables option (seelog_os_environments
in an example configuration file).Save the ClearML configuration file. ClearML is now configured for the ClearML Server.