v2.4.0

New features and improvements

• Add show/hide matching filter control to UI Task Scalars and Plots (ClearML #744, ClearML #1253)
• Task Comparison view: Display task color indicators in task list instead of task legend (ClearML #1461)
• Add support for setting task type during UI task creation (ClearML Web #115)
• Add configuration-based overrides for default Elasticsearch mappings
• Add UI task clone options to reset Python requirements
• Update Elastic to version 8.19.9
• Make Task Repository URL in Task Execution tab clickable
• Support short project names (fewer than 3 characters)

Bug Fixes

• Fix API Server sometimes crashes on sharded Redis deployments (ClearML Server #305)
• Fix UI bulk task reset affecting published tasks (ClearML #1490)
• UI Object table filters:
  • Fix "User" filter in UI "All Models" table not displaying users who have no tasks
  • Fix "User" filter displaying outdated user names after name change
• Fix tasks not appearing in the correct queue after being moved in UI Orchestration > Queues
• Fix UI Task Scalars tab hiding multiple graphs with the same name when toggling one
• Fix Scientific notation can't be used in integer/float fields in UI Pipeline "New Run" modal
• Fix "Enqueue" button is enabled in UI Task "Enqueue" / " Retry" modal when "Queue" field is blank
• Global search
  • Fix filter section not displaying by default when switching from Advanced to Basic search modes
  • Fix filter indicator appearing on all search tabs instead of the active tab
  • Fix spaces being removed while typing in search term
• Fix Project Path icon displayed on Root Project folder in UI Reports page
• Fix last graph legends in UI task table comparison view are obscured
• Fix project tag filters displaying task tags in UI Projects
• Fix sorting not working in UI task comparison selection
• Fix missing "Edit" button in task Configuration tab
• Fix UI comparison plots incorrectly merging subplots with multiple variants
• Fix “No data to show” message incorrectly appearing while UI pages load
• Fix Projects Workload graph's tooltip does not display all legends

v2.3.0

New Features and Improvements

• New Project Workloads dashboard: View project resource utilization by resource, user, and subproject
• New Global Search advanced mode: Direct API filter specification for more specific queries
• Improve single-value scalar Compare view: Separate plot per variant when grouping by metric
• Enable customizing the default name format of cloned tasks

Bug Fixes

• Fix UI GCS credentials popup continues reappearing after broken upload #296
• Fix UI sometimes fails to load large task console logs #295
• Fix deleting parameter in UI task configuration causes other parameters to be duplicated or incorrectly modified
• Fix deleting task in UI removes fileserver folders when "Remove all related artifacts" is not selected
• Fix UI pipeline runs sometimes do not resolve step parameters which are the outputs of previous steps
• Reports
  • Fix scalar plots embedded in UI Reports in full screen mode always grouped by metric
  • Fix embedded plots do not maintain colors specified in code
• Task Comparison
  • Fix Task Scalar Comparison page sometimes displays scalars of tasks removed from comparison
• Task table
  • Fix task status is not updated in the UI Task table when resetting multiple tasks simultaneously
  • Fix UI Task table Tag filter incorrectly switches from ""All"" to ""Any"" option
• Task comparison
  • Fix Task Scalar Comparison page sometimes displays scalars of tasks removed from comparison
  • Fix Task Scalar Comparison does not merge subplots into single plot
• Global search
  • Fix UI Global Search “Load More” button appears unnecessarily
  • Fix selecting a project in Global Search blocks going back to All Tasks, Models, or the previous tab.
• Object table filters
  • Fix UI object table "Users" filter displays only users who reported tasks, instead of all relevant users.
  • Fix UI tables' Project column filter does not list all projects
• Fix run time of re-enqueued failed/aborted tasks includes time between failed/aborted state and running state
• Fix UI Task and Model tags are not updated when tags are deleted

v2.2.0

New Features and Improvements

• Update fixed users password note in apiserver.conf (#284, thanks @djiboshin!)
• New UI global search including quick filters (ClearML #1041)
• Add persistent UI plot properties: Plot settings (e.g. logarithmic/linear scale, hover mode) are retained across project tasks
• Add option to hide original graph when smoothing is enabled in UI plot (ClearML #1400)
• Add persistent UI table details view (ClearML Web #105)
• Add search bar to UI Queues table

Bug Fixes

• Fix embedded UI task comparison plot legends unnecessarily display task ID suffixes (ClearML #1344)
• Fix UI task dataset alias does not link to dataset page (ClearML #735)
• UI task comparison parallel coordinate view:
  • Fix color selector in legend does not display currently assigned color
  • Fix embedded plot does not display plot legend
  • Fix full screen missing legend and title, and displaying all graphs in same color
• UI Plots:
  • Fix x-axis units are not updated after selection is modified
  • Fix UI plot "Show closest data" toggle not displaying in Plotly 2D and 3D scatter plots
  • Fix highlight lines for "show closest data" function in UI 3D plot difficult to see in dark mode
  • Fix plotly pointcloud is displayed monochromatically in UI plots (ClearML #1428)
  • Fix embedded plots sometimes fail to display
• Queues:
  • Fix UI queue creation modal allows invalid display name input
  • Fix queue display name is updated after modification in UI Orchestration > Queues page
• Fix project path indicator not displaying in UI project card's
• Fix refreshing UI Model Endpoints > Loading tab navigates to another tab
• Fix UI Dataset navigation bar sometimes disappears
• Fix UI object table is sometimes not displayed in info panel view
• Fix UI Settings API credential labels sometimes disappear
• Fix default output destination indicator not displaying in UI project cards
• Fix "Clear Filters" functionality sometimes does not work in UI task scalar comparison
• Fix UI report preview sometimes does not load
• Fix UI tables' Project column filter does not list all projects
• Fix UI "Create Project" modal sometimes allows for creation of project with invalid date

v2.1.0

New Features

• New UI task creation options
• Support bash as well as python scripts
• Support file upload
• Add per project UI scalar view configuration (clearml #1377)
• Add support for custom x-axis label in UI Task scalars
• Add global search bar to all UI pages
• Add filter to UI Model Endpoints table
• Add clicking UI breadcrumbs project name of full-screen task opens the project’s task table (clearml #1376)
• Improve UI task debug sample viewer:
• Zoom setting persists when navigating between samples (clearml #1390)
• Zoom focuses on cursor position

Bug Fixes

• Fix EMA smoothing in UI scalars is incorrect in first data point (clearml-web #101)
• Improve UI scalar smoothing algorithms (clearml-web #101, #102, #103)
• Fix UI Plots does not respect plotly aspectmode (clearml #1389)
• Fix ctrl-f does not open a search bar in UI editor modals (ClearML Web #99)
• Fix UI original series of smoothed plots barely visible in dark mode (#270)
• Fix webserver configuration environment variables don't load with single-quoted strings (#271)
• Fix next/previous function not working in UI model plots in full-screen
• Fix UI pipeline "Preview" tab sometimes displays "Failed to get plot charts" error
• Fix image plots sometimes not rendered in UI
• Fix UI plot legend state is not persistent
• Fix parameter graph color is not persistent between plots in UI Model Endpoint
• Fix UI Pipeline Stage Info modal displays broken link
• Fix UI Model table tag filter displaying unnecessary artifacts after excluding tag
• Fix "All" tag filter not working in UI model selection modal in comparison pages
• Fix UI task table displaying incorrect footer sometimes
• Fix task status not updating in UI task comparison page
• Fix manual refresh function sometimes does not work in UI task full screen view
• Fix recently modified reports not displayed in UI "Recent Reports"
• Fix UI task plot zoom not maintained between full screen and regular view (clearml-web #106)
• Fix UI scalar graph colors sometimes difficult to see in light mode (clearml-web #104)
• Fix UI task comparison's metric search bar in Scalars tab is case sensitive
• Fix UI task configuration long loading time
• Fix embedded UI task comparison parallel coordinates plot does not display plot legend
• Fix UI embedded plot colors do not change upon UI theme change
• Fix deleting a parameter in the UI task creation modal incorrectly removes another parameter
• Add support for comparing tasks from specific project in UI Reports customized embed queries
• Fix clicking "Details" view causes UI Model data to disappear
• Fix UI scalars hide/unhide function sometimes doesn't work for single-variant metrics
• Fix maximizing UI scalar plot raises an error
• Fix clicking on task in UI Model lineage navigates to incorrect page
• Fix UI breadcrumbs sometimes does not display project name

v2.0.0

Breaking Changes

MongoDB major version was upgraded from v5.x to 6.x.
Please note that if your current ClearML Server version is smaller than v1.17 (where MongoDB v5.x was first used), you'll need to first upgrade to ClearML Server v1.17.

Upgrading to ClearML Server v1.17 from a previous version

• If using docker-compose, use the following docker-compose files:
  • docker-compose file
  • docker-compose file foe Windows

New Features

• New look and feel: Full light/dark themes (clearml #1297)
• New UI task creation options
  • Support bash as well as python scripts
  • Support file upload
• New UI setting for configuring cloud storage credentials with which ClearML can clean up cloud storage artifacts on task deletion.
• Add UI scalar plots presentation of plots in sections grouped by metrics.
• Add UI Batch export plot embed codes for all metric plots in a single click.
• Add UI pipeline presentation of steps grouped into stages

Bug Fixes

• Fix UI Model Endpoint's Number of Requests plot sometimes displays incorrect data
• Fix UI datasets page does not filter according to project when dataset is running
• Fix UI task scalar legend does not change colors when smoothing is enabled
• Fix queue list in UI Workers and Queues page does not alphabetically sort by queue display name
• Fix queue display name is not searchable in UI Task Creation modal's queue field

v1.17.0

New Features

• New ClearML Model dashboard: View all live model endpoints in a single location, complete with real time metrics reporting.
• New UI pipeline run table comparative view: compare plots and scalars of selected pipeline runs
• Improve services agent behavior: If no credentials are specified, agent uses default credentials (ClearML Server GitHub issue #140)
• Add UI re-enqueue of failed tasks
• Add UI experiment scalar results table view
• Add "Block running user's scripts in the browser" UI setting option for added security
• Add UI "Reset" to set task installed packages to originally recorded values
• Add UI edit of default Project default output destination

Bug Fixes

• Fix broken download links to artifacts stored in Azure (ClearML Server GitHub issue #247)
• Fix Cross-site Scripting (XSS) vulnerability (CWE-79)
• Fix UI experiment textual comparison diff showing contextual diffs as different contents (ClearML GitHub issue #646)
• Fix UI experiment comparison does not overlay box plots and histograms (ClearML GitHub issue #1298)
• Fix UI plots display “Iteration 0” when it is the only reported iteration (ClearML GitHub issue #1267)
• Fix scalar series starting with angle bracket (<) causes UI scalar plot legend to display raw html (ClearML GitHub issue #1292)
• Fix UI scalar plot not displayed if metric name includes a slash surrounded by spaces (/)
• Fix Model API calls fail when its creating task has been deleted (ClearML GitHub issue #1299)
• Fix UI experiment debug samples disappear while task is running (ClearMLGitHub issue #1259)
• Fix UI pipeline DAG display to be "bottom-up" so all final steps appear in the bottom of the diagram (ClearML Web GitHub PR #86)
• Fix invalid mongodb connection string if CLEARML_MONGODB_SERVICE_CONNECTION_STRING is specified (ClearML Server GitHub issue #252)
• Fix UI image plot retrieval from fileserver missing authentication cookie (ClearML GitHub issue #1331)
• Fix pipeline run version not set when re-executed via the UI
• Fix metric and hyperparameter group string not searchable in UI table
• Fix UI model hidden plot selection does not persist upon refresh
• Fix deleting large number of experiments via UI not working properly
• Fix experiment name legend not displayed in UI experiment plot comparison
• Fix archiving pipeline run does not abort pipeline step tasks
• Fix "Restore" and "Delete" buttons missing from UI experiment archive action bar
• Fix UI experiment debug sample viewer sometimes displays incorrect sample
• Fix UI Settings' Configuration section does not display indication that the number of credentials limit has been reached
• Fix Hydra parameters not displaying correctly in UI experiment comparison parallel coordinates plot
• Fix UI Reports image upload not working
• Fix iteration number not displayed in titles of confusion matrix and table plots in UI experiment comparison
• Fix "Create new" option not displaying when inputting project name in UI Report creation modal
• Fix UI experiment requires Git information when repository isn't set
• Fix moving an enqueued experiment to a new UI queue results in error
• Fix modifying UI experiment input models does not work

v1.16.2

Bug Fixes

• Fix no graphs are shown in workers and queues screens

v1.16.1

Bug Fixes

• Fix user credentials reset on apiserver restart (#250)

v1.16.0

New Features and Improvements

• New UI "new experiment creation"
• ClearML File Server now uses authentication by default. This can be turned off using the fileserver.auth.enabled: false configuration setting
• Add confirmation pop-up when running experiment is archived

Bug Fixes

• Fix model plots not displayed in UI model plot tab
• Fix UI experiment Debug Samples tab freezes when a lot of debug samples are reported in the experiment
• Fix UI scalar “Export to CSV” button returns an empty CSV file
• Fix large number of tags in UI tables' tag filter causes UI to crash
• Fix searching in UI object tables' tag filter causes UI to crash
• Fix consistent plot colors not maintained when embedded in UI Reports (clearml/clearml#1239)
• Fix UI plot legends and tooltips wrapping (#241)
• Fix multiple parameters can be selected for plot axes in scatter plot view in UI experiment comparison
• Fix image names change in UI task debug sample comparison when a different metric is selected
• Fix numeric range filters of UI table columns not working
• Fix queue experiment list is not updated in the UI Orchestration's Queues page
• Fix My work/Team work persists across UI modules (i.e. projects, datasets, pipelines, etc.)
• Fix UI single-scalar plots are not ordered alphabetically by scalar name
• Fix limit on file uploads to the fileserver

v1.15.0

New Features and Improvements

• UI experiment hyperparameter comparison
  • Add Parallel coordinate view support for multiple metrics
  • Add scatter plot mode to UI experiment hyperparameter comparison clearml #984
• Add model lineage to UI model comparison
• Update nginx version to Fix 1-Byte Memory Overwrite RCE vulnerability #230

Bug Fixes

• Fix Heap Buffer Overflow vulnerability (CVE-2023-38545) #234
• Fix insufficient session expiration issue (CWE-613)
• Fix XSS issue (CWE-79) in UI markdown
• Fix UI reports vulnerable to XSS attack
• Fix UI generating undefined credentials for Jupyter Notebook clearml-web #67
• Fix "No tags" filter raises an error
• Fix slow loading speed for UI experiment comparison scalars
• Fix some UI experiment sometimes missing plots
• Fix delete not working in batch action bar in UI models tables
• Fix dequeue not working from UI experiment table batch action bar
• Fix UI plots and scalars are displayed in reset experiments
• Fix embedded scalar comparison plot does not display metric variant in maximized view in UI Reports
• Fix "Copy embed code" not working properly in comparison plot
• Fix incorrect plot name is displayed when expanding UI scalar plots
• Fix task IDs not displayed in UI experiment comparison graph titles and legends
• Fix single-value scalar plot not displaying "Download CSV" button when embedded in UI report
• Fix UI dashboard search returns results from team’s work when "My Work" filter is enabled.
• Fix UI experiment table compare view does not persist
• Fix UI Workers and Queues displaying incorrect statistics
• Fix UI experiment scalar comparison missing active filter indicator
• Fix UI scalar value comparison sometimes displays empty page
• Fix UI embedded plots missing titles and axis labels
• Fix missing status filter in UI All Models table
• Fix UI pipeline table "No value" selection does not work with version filter
• Fix UI experiment table compare view presents plots from unselected experiments
• Fix using filter causes UI experiment console to jump