First Steps
#
Install ClearMLFirst, sign up for free
Install the clearml
python package:
#
Connect ClearML SDK to the ServerExecute the following command to run the ClearML setup wizard:
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.
Now you can integrate ClearML into your code!
#
Auto-log ExperimentIn ClearML, experiments are organized as Tasks.
ClearML will automatically log your experiment and code, including outputs and parameters from popular ML frameworks, once you integrate the ClearML SDK with your code. To control what ClearML automatically logs, see this FAQ.
At the beginning of your code, import the clearml
package:
Full Automatic Logging
To ensure full automatic logging, it is recommended to import the clearml
package at the top of your entry script.
Then initialize the Task object in your main()
function, or the beginning of the script.
Task name is not unique, it's possible to have multiple experiments with the same name. If the project does not already exist, a new one will be created automatically.
The console should return the following output:
That’s it! You are done integrating ClearML with your code :)
Now, command-line arguments, console output as well as Tensorboard and Matplotlib will automatically be logged in the UI under the created Task.
Sit back, relax, and watch your models converge :) or continue to see what else can be done with ClearML here.
#
Youtube PlaylistOr watch the Youtube Getting Started Playlist on our Youtube Channel!