clearml-docs/docs/webapp/webapp_overview.md

title
WebApp

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

• ML workload automation
• Resource utilization monitoring and management
• Live model endpoint monitoring
• ML experiment management and visualization
• Model and Dataset viewing and management
• Pipeline creation and monitoring
• User and administrator settings

UI Modules

The WebApp's sidebar provides access to the following modules:

• Applications - ClearML's GUI applications for no-code workflow execution (available in the ClearML Pro and Enterprise plans).

• Orchestration - Autoscaling, resource usage monitoring and allocation management.

• Model Endpoints - Monitor your live model endpoints.

• Datasets - View and manage your datasets.

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

  • Track ongoing tasks and visualize their results
  • Reproduce previous task runs
  • Tune task parameter values with no code change
  • Compare tasks and models
  • Share tasks and models with other ClearML hosted service users
  • Create and share rich content Reports

• Pipelines - View and manage your pipelines.

UI Top Bar

Settings Menu

Click the profile menu button to access the following:

• Settings - Navigate to ClearML's Settings page:
  • Set personal WebApp preferences
  • Manage workspace API credentials
  • Manage personal configuration vault (Enterprise offering)
  • Configure cloud storage access credentials for the ClearML Web UI
  • Administrator settings
    • Manage users and workspaces
    • View usage and billing information (Free Hosted Service)
    • Manage access rules (available in the ClearML Enterprise plan)
    • Define configuration vaults to apply to designated user groups (available in the ClearML Enterprise plan)
    • Manage server identity providers (available in the ClearML Enterprise plan)
    • Define the resource access policies (available in the ClearML Enterprise plan)
• Workspace Control (Free Hosted Service)
  • Invite a User to your workspace (supported in hosted service). Click Invite a User > input user's email > click ADD > page redirects 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.
• Appearance - Select the UI color scheme:
  • Light: ClearML will be in a light theme.
  • Dark: ClearML will be in a dark theme.
  • System: ClearML will follow your device’s theme.
• Logout of ClearML

Finding What You're Looking for

The ClearML UI provides two search options on most pages:

• In-page search: Each object (e.g. projects, tasks etc.) page includes its own search bar for filtering the objects shown on that page. This search focuses on attributes relevant to that object type:
  • Projects: show projects whose name or ID match the searched text
  • Tasks: show tasks whose name, ID, description, or input/output models match the searched text
  • Models: show models whose name, ID, or description match the searched text.
  • Dataviews: show dataviews whose name, ID, description, hyper-datasets, or hyper-dataset versions match the searched text.
  • Reports: show reports whose name, ID, tags, project, description, or content match the searched text.
  • Datasets: show datasets whose name, ID, or description match the searched text
  • Pipeline Runs: show reports whose name, ID, or description match the searched text
• Global search: The search bar on the top banner of every page searches the whole WebApp for objects that match the queries as specified above and returns results grouped by object (projects, tasks, models, etc.).

To use regular expressions, click the .* icon in the search bar.

:::tip Additional filtering ClearML's object tables (e.g. tasks, models, pipelines, and datasets) provide column filters to easily focus your search by object properties (e.g. status, creation/update time, metric values, etc.). :::

Helpful Resources

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

• ClearML Python Package setup - Instruction to get started with the clearml Python package
• ClearML on YouTube - Instructional videos on integrating ClearML into your workflow
• Online Documentation
• Pro Tips - Tips for working with ClearML efficiently
• Contact Us - Quick access to ClearML contact form