The ClearML Web UI is the graphical user interface for the ClearML platform, which includes:
- Experiment management
- Resource utilization monitoring
- Profile management
- Direct access to the ClearML community (Slack Channel, YouTube, and GitHub).
The WebApp's sidebar provides access to the following modules:
- Dashboard - The dashboard for recent activity and quick access to experiments and projects.
- Projects - 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:
- Datasets - View and manage your datasets.
- Pipelines - View and manage your pipelines.
- Reports - View and manage your reports.
- Orchestration - Autoscale, monitor, and manage your resource usage and workers queues.
- Applications - ClearML's GUI applications for no-code workflow execution.
UI Top Bar
Click the profile menu button in the top right corner of the web UI screen to access the following:
- Settings - Navigate to ClearML's user Settings page:
- 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)
- 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.
- 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.
Search results are returned for the different ClearML objects:
- Experiments - Searching an experiment table looks for matches in the experiments' name, ID, description and input and output models. The enterprise version also includes experiment Dataviews' hyper-datasets and versions.
- Models - Searching a Model table looks for matches in the models' name, ID and description.
- Dataviews (Enterprise only) - Searching a Dataviews table looks for matches in the Dataviews' name, ID, description, hyper-datasets, and versions.
- Datasets - Searching the datasets page looks for matches in the datasets' name, ID, and description. In a dataset's version table, a search looks for matches in the versions' name, ID, and description.
- Pipelines - Searching the pipelines page looks for matches in the datasets' name, ID, and description. In a pipeline run's table, a search looks for matches in the runs' name and ID.
- Reports - Searching the reports page looks for matches in the reports' name, ID, tags, project, description, and report content.
The search bar in the Dashboard page searches the whole WebApp for objects that match queries as specified above and returns results divided by object type (projects, experiments, models, etc.).
Click the help menu button in the top right corner of the web UI screen to access the self-help resources including: