Getting Started using the Free ClearML Hosted Service

The free ClearML Hosted Service is the ClearML backend infrastructure (ClearML Server) maintained for you. It is always available to anyone who signs up. You can work independently and collaborate in teams of up to three. Members of a team share a workspace, have full access to each other’s work, and can execute up to ten experiments concurrently.

Any team member can install, configure, and run the ClearML Agent on a GPU machine for MLOps (for example, reproduce experiments or execute automate workflows). A running instance of ClearML Agent (a worker) is available for all team members to use.

The ClearML Hosted Service also supports sharing experiments and their models, without joining a team. Shared experiments are read-only.

Getting Started

To get started using the free ClearML Hosted Service:

  1. How you signup for the ClearML Hosted Service depends upon whether you are want to:

    • Work independently or start a new team - Open the signup page in your browser, app.community.clear.ml.

    • Join a team - Get an invitation link from a current team member who creates the link and send it to you (see Inviting New Teammates).

  2. On the signup page, choose an identity for your hosted service login: BitBucket, GitHub, or Google.

  3. If the identity’s provider requires access confirmation, grant access.

  4. Complete the signup form.

  5. Read Allegro AI’s Privacy Policy and Terms of Use, and click ACCEPT.

  6. Click SIGN UP.

    If you do not work on code, you are ready to start using ClearML.

    If you do work on code, install and configure the ClearML Python Package (see the next section on this page).

    Note

    To reproduce experiments or execute automated workflows, you need a worker. Workers can be created for you, or you can create them. See all workers that available in your workspace on the ClearML Web UI, Workers and Queues page.

  7. In a terminal session, run the ClearML setup wizard (if you did not already install clearml, install it and then run setup wizard).

     clearml-init
    
    1. The setup wizard prompts for your ClearML credentials.

       ClearML SDK setup process
      
       Please create new clearml credentials through the profile page in your clearml web app (e.g. http://localhost:8080/profile)
       Or with the free hosted service at https://app.community.clear.ml/profile
       In the profile page, press "Create new credentials", then press "Copy to clipboard".
      
       Paste copied configuration here:
      
    2. Get your ClearML credentials. Open the ClearML Web UI in your browser. On the PROFILE page, click Create new credentials > Copy to clipboard.

    3. At the command prompt Paste copied configuration here:, copy and paste the ClearML credentials.

      The setup wizard confirms the credentials.

       Detected credentials key="********************" secret="*******"
      
    4. Enter the ClearML Server web server URL, or press Enter to accept the default which is detected from your credentials.

       WEB Host configured to: [https://app.community.clear.ml]
      
    5. Enter the ClearML Server API server URL, or press Enter to accept the default value which is based on your previous response:

       API Host configured to: [https://api.community.clear.ml] 
      
    6. Enter the ClearML Server file server URL, or press Enter to accept the default value which is based on your previous response:

       File Store Host configured to: [https://files.community.clear.ml] 
      

      The wizard responds with your configuration and directs you to your ClearML Server.

       CLEARML Hosts configuration:
       Web App: https://app.community.clear.ml
       API: https://api.community.clear.ml
       File Store: https://files.community.clear.ml
      
       Verifying credentials ...
       Credentials verified!
      
       New configuration stored in /home/<username>/clearml.conf
       CLEARML setup completed successfully.
      

The configuration file’s location depends upon your operating system:

  • Linux - ~/clearml.conf

  • Mac - $HOME/clearml.conf

  • Windows - \User\<username>\clearml.conf

Next Steps

  • Invite others to collaborate with you.

  • Learn about ClearML:

    • Fundamentals - ClearML essential concepts.

    • Examples - Example scripts which are ready run and pre-loaded in ClearML.

    • Tutorials - Step-by-step instructions for explicitly reporting, tuning experiments, and creating tracking leaderboards.

    • Web UI - The ClearML Web UI user guide section. Learn how the experiment manager features and functions.

    • Integrations - ClearML integrations with ML / DL libraries and development tools.