clearml-docs/docs/release_notes/ver_1_10.md

title
Version 1.10

ClearML SDK 1.10.0

Breaking Changes

• StorageManager.download_file() and StorageManager.download_folder() from MinIO and Azure no longer include bucket name in target local path ClearML GitHub issue #709

New Features and Improvements

• Add support for attaching plots and scalars to models
• Add Task.get_debug_sample() to retrieve task's debug samples ClearML GitHub issue #761
• Add custom artifact serialization for pipelines ClearML GitHub issue #689
• Add table layout configuration to Logger.report_table() through extra_data parameter #796
• Add PipelineController.connect_configuration() to add configuration dictionaries to a pipeline
• Add Dataset.delete() configurable hosted contents deletion support:
  • Delete ClearML file server hosted files
  • Delete external storage hosted files
• Add force_download argument to Model.get_local_copy() to force download a new copy of a model even if already in cache
• Add PipelineController.is_successful() criteria customization
• Add support for API v2.23
• Add Getting Started Notebooks ClearML PR #948
• Improve hyper_parameter example ClearML PR #927
• Correct Task.connect() docstring ClearML Docs issue #473
• Improve the Task.mark_completed() and Task.close() docstrings ClearML Docs issue #486

Bug Fixes

• Fix logging dependencies that use the subdirectory argument when pip installing from a git repo ClearML GitHub issue #946
• Fix Task.import_offline_session() does not import offline models ClearML GitHub issue #653
• Fix clearml-init incorrectly sets Web and API server ports Clearml Server GitHub issue #181 & ClearML GitHub issue #910
• Fix multiple models trained by the same framework are not all automatically logged ClearML GitHub issue #767
• Fix parallel coordinates plot displays categorical variables unclearly ClearML GitHub issue #907
• Fix runtime toggling task offline mode in the context of an open task
• Fix information not being captured from Jupyter Notebook in Sagemaker studio
• Fix python-fire support
• Fix mishandling nested dictionaries in Task.connect() in PipelineDecorator
• Fix pipeline version number isn't updated when auto_version_bump is set to True
• Fix get_or_create_project crashes when run in parallel
• Fix task auto-publishing is not backwards compatible
• Fix task.get_user_properties(value_only=True) raises exception
• Fix CLEARML_VCS_DIFF set to empty string does not cause task to log empty uncommitted changes
• Fix silence_errors parameter in StorageManager.get_file_size_bytes() not working
• Fix setting Dataset metadata name to a string prefixed with data_ breaks Dataset.get()
• Fix Pipeline fails creating tasks from multi-argument functions

ClearML Server 1.10.0

New Features and Improvements

• Additional model information
  • Add Lineage tab to UI model page, which displays experiment that created model and lists experiments that use the model ClearML GitHub issue #810
  • Add Plots and Scalars tabs to UI Model page
• Add project hierarchy view for ClearML resources (pipelines, datasets, hyper-datasets, reports) ClearML GitHub issue #724:
  • Flat view - all objects displayed side-by-side
  • Nested view - objects grouped by containing projects.
• Add archived experiment inclusion in UI experiment comparison ClearML GitHub issue #795
• Update ElasticSearch image to 1.17.7 ClearML Server GitHub issue #183
• Add reported plot support for multiple color formats
• Add running tasks to UI project overview metric snapshot
• Improve UI Reports:
  • Add option to upload and embed images from PC
  • Add option to embed experiment comparison parallel coordinates plots and full screen debug sample
• Add UI indicator to hidden resources when "Show hidden projects" is enabled
• Add Experiment comparison UI parallel coordinate plots full screen view

Bug Fixes

• Fix UI scalar plot smoothing is biased towards initial value ClearML Server GitHub issue #180
• Fix UI experiment plot comparison not merging plots
• Fix UI reports search bar doesn't search report descriptions
• Fix UI reports search bar does not close after result is selected
• Fix UI user preferences don't persist in duplicate tab or after logout/login
• Fix UI pipeline step names are cropped with no available tooltips
• Fix refreshing UI console output scrolls away from latest entries
• Fix UI experiment artifact list not updated upon artifact deletion
• Fix UI experiment comparison Hyperparameters tab scroll erratic behavior in Firefox
• Fix UI console log partially showing pipeline log entries
• Fix can't move UI Report to root project
• Fix queue isn't selected when name is clicked in the UI enqueue modal
• Fix turning off filter in UI experiment table does not persist
• Fix UI plot lines appearing in wrong places in plot
• Fix newly created dataset tags missing from dataset filter tag list
• Fix unclear text in UI plots downloaded as PDF/PNG
• Fix UI global search incorrectly returns 0 Dataset/Reports count
• Fix long named reports flash upon hover
• Fix disappearing UI scalar graph when "Group by" is set to "None"
• Fix UI experiment plots horizontal axis units change to "Iterations" when refreshed
• Fix UI scalar graphs do not update when horizontal axis units are changed
• Fix tooltip does not appear when hovering over name in UI breadcrumbs
• Fix UI experiment scalar smoothing does not persist in plot fullscreen
• Fix newly created report tags missing from report filter tag list
• Fix reports names can contain a "/"
• Fix My work / Team work filter selection does not persist upon app refresh