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

v1.14.1

New Features and Improvements

• Add support for serving UI from a subpath
• Change default cookie SameSite setting to Lax

Bug Fixes

• Fix clicking on UI Metric Snapshot datapoint does not navigate to experiment #228
• Fix some APIs not sanitizing query parameters
• Fix downloading UI experiment console log sometimes returns an older file
• Fix UI experiment plot comparison displays duplicates of image plots
• Fix missing experiment labels in UI experiment plot comparison
• Fix starting time not updating for some tasks

v1.14.0

New Features and Improvements

• New UI experiment table comparative view: compare plots and scalars of all selected experiments
• Add UI experiment display of original python requirements along with actual packages used (clearml/clearml#793)
• Add UI project metric snapshot support for multiple metrics
• Add compressed UI experiment table info panel mode displaying only experiment name and status
• Add "x unified" hover mode to UI plots
• Add experiment hyperparameter UI section dataset IDs link to datasets page
• Make all URLs clickable in UI experiment artifacts
• Redesign WebApp tabs: Tabs now appear in UI header
• Add option to force setting original task as clone's parent when cloning a task

Bug Fixes

• Fix CVE-2023-45133 Web App vulnerability
• Fix "select all" in UI dataset archive displays count of all archived and non-archived experiments
• Fix hyperparameter keys with dots in their names displayed incorrectly in UI experiment table and task info
• Fix UI experiment scalar comparison raising error
• Fix “Project” column redundantly appears inside a specific project's model table
• Fix UI models with many labels slowing down web app
• Fix simple UI plots (scatter, bar, etc.) in experiment comparisons not merging by experiment
• Fix UI pipeline details panel does not display information
• Fix UI plot "Show/hide" legend button sometimes disappears
• Fix can't select root project in UI report creation modal when workspace has no projects
• Fix "load more" button displayed unnecessarily in UI object tables
• Fix archive action in UI dataset table archives unselected datasets

v1.13.1

Bug Fixes

• Fix GCS credentials keep popping up
• Fix long name overflows onto show/hide button in scalar metric list

v1.13.0

New Features and Improvements

• Improve UI comparison views
  • Add visual comparison of single value scalars #202
  • Scalar value comparison: metrics are presented in a single table clearml #760
  • Add global experiment legend: Experiment name, tags and color clearml #81
  • Clickable URLs/object IDs in experiment details comparison clearml #1073
• UI Search improvements
  • Dashboard search results ordered by update time
  • Top bar search query saved in URL
• Improve UI experiment debug sample iteration fetching speed #170
• Add UI cloud credentials support for GCS signed URLs with HMAC authentication
• Add Experiment plot UI support for displaying subplots

Bug Fixes

• Fix UI single-value scalars table does not display all single-value scalars clearml #1111
• Fix UI pipeline step duration does not update during runtime clearml #1090
• Fix UI experiment comparison parallel coordinates plot crops the metric and parameter names clearml #1111
• Fix hidden experiments appear in UI All Experiments search results clearml #1139
• Fix Markdown Editor Cross-site Scripting (XSS) vulnerability
• Fix disabled graphs in UI scalars reappear in full-screen mode
• Fix UI auto-refresh sometimes causes many error message to be raised
• Fix "All" tag filter not working in UI object pages
• Fix tag filter in UI dataset page does not persist on refresh
• Fix scalars and plots are not displayed in UI model page
• Fix UI pipeline step status does not update
• Fix UI experiment comparison plots don't display all experiments in legend
• Fix UI Model Lineage tab sometimes doesn't display models
• Fix some plots present partial data in UI experiment comparison plots
• Fix clicking URL of deleted UI report navigates to empty page
• Fix applying UI tag in bulk raises an error
• Fix task IDs appear multiple times in UI task comparison plot legends
• Fix UI project filter in All Experiments table takes a long time load
• Fix custom columns in UI tables do not persist on refresh
• Fix UI report card missing creating user's name
• Fix new tag is not displayed in "Add Tag" table action menu until page refresh
• Fix clicking on worker name in Orchestration page's Queue info panel does not navigate to the worker's info panel
• Fix clicking on older empty UI datasets redirects to 404 page
• Fix experiment names don't appear in the plot legend in UI experiment comparison scalar plots grouped by metric
• Fix task ID does not appear in UI task comparison plots of tasks with the same name
• Fix UI scalar comparison's Horizontal Axis, Smoothing, and Group by selections do not persist upon experiment selection modification
• Fix UI scalars sometimes missing plots in Chrome
• Fix values can't be input into the UI scalar smoothing field
• Fix UI experiment configuration is sometimes not editable
• Fix UI project name tooltips don't appear for projects with long names
• Fix debug samples appear in UI experiment only after refresh
• Fix cropped names in tag list in "Add Tag" action in UI table action menu
• Fix UI experiment configuration tooltip obscure the “Edit” button
• Fix Markdown editor XSS vulnerability (thanks @vvxhid, @ouxs-19, @malikDaCoda and @m0kr4n3 for reporting!)