clearml-docs/docs/webapp/webapp_overview.md

title
Overview

The ClearML Web UI is the graphical user interface for the ClearML platform, which includes:

• Experiment management
• Browsing
• Resource utilization monitoring
• Profile management
• Direct access to the ClearML community (Slack Channel, Youtube, and GitHub).

The ClearML Web UI is composed of the following pages:

• The Home Page - The dashboard for recent activity and quick access to experiments and projects.

• The Projects Page - The main experimentation page. Access your experiments and models as they are organized into projects. The experiments and models are displayed in tables which let you:

  • Track ongoing experiments and visualize their results
  • Reproduce previously run experiments
  • Tune experiments with no code change
  • Compare experiments
  • Share experiments and their models with other ClearML hosted service users
  • Archive experiments and models

• The Workers and Queues Page - The resource monitoring and queues management page.

• The Settings Page - Manage your ClearML user account:

  • Set WebApp preferences
  • Manage workspace API credentials
  • Configure Cloud Storage Access credentials for the ClearML Web UI
  • ClearML Hosted service specific options
    • View usage information
    • Manage users and workspaces
    • Manage resource access permissions (Available in the ClearML Enterprise plan)

  To navigate to the Settings page, click the button in the top right corner of the web UI screen, then click Settings.

WebApp Menus

Click the help menu button in the top right corner of the web UI screen to access the self-help resources including:

• ClearML Documentation
• Pro Tips - Tips for working with ClearML efficiently
• ClearML Python Package setup - Instruction to get started with the clearml Python package
• Contact Us - Quick access to ClearML contact form

Click the profile menu button in the top right corner of the web UI screen to access the following:

• Settings - Navigate to ClearML's Settings page
• Invite a User to your workspace (supported in hosted service). Click Invite a User > input user's email > click ADD > page will redirect to the Users & Groups section of the Settings page
• Switch to Workspace - Hosted service users can be members of multiple workspaces. These workspaces are listed here. Click a workspace to switch to.
• Logout of the workspace

Community

In addition, from the ClearML Web UI, use these buttons to access the ClearML community resources:

• The ClearML Slack channel. Ask questions about ClearML.
• The ClearML YouTube Channel. View our tutorials, presentations, and discussions.
• The ClearML GitHub repository.

For more information, see the Community page.