6.3 KiB
| 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
Use the search bar 
to find your ClearML resources.
To search using regex, click the .* icon on the search bar.
The search functionality is tailored to each page, returning results specific to the object type displayed on the page. For example, searching a task table looks for matches in the tasks' name, ID, description and input and output models. On the reports page, it matches reports by name, ID, tags, project, description, and content. Similarly, searches in models, datasets, pipelines, dataviews, and annotations, focus on attributes relevant to their respective objects.
The search bar in the Project Dashboard page searches the whole WebApp for objects that match queries as specified above and returns results divided by object type (projects, tasks, models, etc.).
:::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
clearmlPython 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