Skip to main content

Version 1.1

ClearML Serving 1.1.0

Backwards Compatibility

This release is not backwards compatible - see notes below on upgrading

Breaking Changes

  • Triton engine size supports variable request size (-1)

Features & Bug Fixes

  • Add version number of serving session task
  • Triton engine support for variable request (matrix) sizes
  • Triton support, fix --aux-config to support more configurations elements
  • Huggingface Transformer support
  • Preprocess class as module

ClearML Agent 1.1.2

Bug Fixes

  • Fix the six conflict with the new pathlib2 version 2.3.7 and up.

ClearML SDK 1.1.6


  • Add Task.force_store_standalone_script() to force storing standalone script instead of a Git repository reference ClearML GitHub issue #340
  • Add Logger.set_default_debug_sample_history() and Logger.get_default_debug_sample_history() to allow controlling maximum debug samples programmatically
  • Add populate now stores function arg types as part of the hyperparemeters
  • Add status_message argument to Task.mark_stopped()
  • Change HTTP driver timeout and retry codes (connection timeout will now trigger a retry)

Bug Fixes

  • Fix and upgrade the SlackMonitor ClearML GitHub issue #533
  • Fix network issues causing Task to stop on status change when no status change has occurred ClearML GitHub issue #535
  • Fix Pipeline controller function support for dict as input argument
  • Fix uploading the same metric/variant from multiple processes in threading mode should create a unique file per process (since global counter is not passed between the subprocesses)
  • Fix resource monitoring should only run in the main process when using threaded logging mode
  • Fix fork patching so that the signal handler (at_exit) will be called on time
  • Fix fork (process pool) hangs or drops reports when reports are at the end of the forked function in both threaded and subprocess mode reporting
  • Fix multi-pipeline support
  • Fix delete artifacts after upload
  • Fix artifact preview has no truth value
  • Fix storage cache cleanup does not remove all entries on a silent fail
  • Fix always store session cache in ~/.clearml (regardless of the cache folder)
  • Fix StorageManager.download_folder() fails on Windows path

ClearML SDK 1.1.5


  • Add support for jsonargpraser ClearML GitHub issue #403
  • Add HyperParameterOptimizer.get_top_experiments_details() returns the hparams and metrics of the top performing experiments of an HPO ClearML GitHub issue #473
  • Allow overriding initial iteration offset using environment variable (CLEARML_SET_ITERATION_OFFSET) or Task.init(continue_last_task==<offset>)ClearML GitHub issue #496
  • Add better input handling for clearml-init in colab ClearML GitHub issue #515
  • Add environment variable for default request method ClearML GitHub issue #521
  • Add LocalClearmlJob as possible option for HPO ClearML GitHub issue #525
  • Add convenience functionality to clearml-data ClearML GitHub issue #526
  • Add support for vscode-jupyter microsoft/vscode-jupyter#8531
  • Improve detection of running reporting subprocess (including zombie state)
  • Support controlling S3/Google Cloud Storage _stream_download_pool_connections using the stream_connections configuration setting in clearml.conf (default 128)
  • Add warning when losing reporting subprocess
  • Add Model.remove() to allow removing a model from the model repository
  • Add HTTP download timeout control (change default connection timeout to 30 seconds)
  • Add initial setup callback to monitoring class
  • Add Task.get_reported_plots()
  • Allow Monitor.get_query_parameters to override defaults
  • Add support for Google Cloud Storage pool_connections and pool_maxsize overrides
  • Add last worker time to AutoScaler
  • Add warning when opening an aborted Dataset
  • Store multi-pipeline execution plots on the master pipeline Task
  • Support pipeline return value stored on pipeline Task
  • Add PipelineDecorator.multi_instance_support
  • Add PipelineDecorator to clearml and clearml.automation namespaces
  • Documentation and examples

Bug Fixes

  • Fix TriggerScheduler on Dataset change ClearML GitHub issue #491
  • Fix links in Jupyter Notebooks ClearML GitHub issue #505
  • Fix pandas delta datetime conversion ClearML GitHub issue #510
  • Fix matplotlib auto-magic detect bar graph series name ClearML GitHub issue #518
  • Fix path limitation on storage services (posix, object storage) when storing target artifacts by limiting length of project name (full path) and task name used for object path ClearML GitHub issue #516
  • Fix multi-processing context block catching exception
  • Fix Google Cloud Storage with no default project causes a crash
  • Fix main process's reporting subprocess lost, switch back to thread mode
  • Fix forked StorageHelper should use its own ThreadExecuter
  • Fix local StorageHelper.delete() raising exception on non-existent file instead of returning false
  • Fix StorageHelper rename partial file throwing errors on multiple access
  • Fix resource monitor fails on permission issues (skip over parts)
  • Fix reusing Task does not reset it
  • Fix support clearml PyCharm Plugin 1.0.2 (support partial pycharm git repo sync)
  • Fix Task.reset() force argument ineffective
  • Fix PY3.5 compatibility
  • Fix validation error causes infinite loop
  • Fix tasks schema prevents sending null container parts
  • Fix missing CLEARML_SET_ITERATION_OFFSET definition
  • Fix Model.get_weights_package() returns None on error
  • Fix download progress bar based on configuration
  • Fix Conda lists the CudaToolkit version installed (for the agent to reproduce)
  • Fix Jupyter kernel shutdown causing nested atexit callbacks leaving Task in running state
  • Fix multi-subprocess can cause Task to hand at close
  • Fix TF 2.7 support (get logdir on with multiple TB writers)

ClearML SDK 1.1.4

Bug Fixes

  • Fix duplicate keyword argument (affects clearml-data, Dataset.get()) ClearML GitHub issue #490
  • Fix session raises missing host error when in offline mode ClearML GitHub issue #489
  • Fix Task.get_task() does not load output_uri from stored Task
  • Fix Task.get_models()['input'] returns string instead of clearml.Model
  • Fix tf.saved_model.load() binding for TensorFlow>=2.0
  • Fix hyperparams with None value converted to empty string causes inferred type to change to str in consecutive Task.connect() calls

ClearML Agent 1.1.1

Features and Bug Fixes

  • Add support for truncating task log file after reporting to server using agent.truncate_task_output_files configuration setting
  • Fix PyJWT resiliency support
  • Fix --stop checking default queue tag ClearML Agent GitHub issue #80
  • Fix queue tag default does not exist and --queue not specified (try queue named "default")
  • Fix Python 3.5 compatibility
  • Fix PY2.7 support for PyTorch

ClearML SDK 1.1.3


  • Add support for MegEngine with examples ClearML GitHub issue #455
  • Add TaskTypes to main namespace ClearML GitHub issue #453
  • Add LogUnifomParameterRange for hyperparameter optimization with Optuna ClearML GitHub issue #462
  • Add joblib (equivalent to scikit) to Task.init(auto_connect_frameworks) argument
  • Log environment variables starting with * in ClearML GitHub issue #459
  • Pipeline
    • Add eager decorated pipeline execution
    • Support pipeline monitoring for scalars/models/artifacts
    • Add PipelineController.upload_model()
    • Add PipelineController.add_step(configuration_overrides) argument allowing to override Task configuration objects
    • Change PipelineController.start_locally() default run_pipeline_steps_locally=False
    • Add PipelineController.stop(mark_failed, mark_aborted) arguments
    • Add PipelineController.run_locally decorator
    • Add PipelineController.continue_on_fail property
    • Add PipelineController.__init__(abort_on_failure) argument
    • Add nested pipeline components missing pipeline tags
    • Add ClearmlJob state cache (refresh every second)
  • Datasets
    • Add clearml-data multi-chunk support
    • Change clearml-data default chunk size to 512 MB
    • Change Dataset.create() now automatically reverts to using current Task if no project/name provided
  • Add Optimizer.get_top_experiments_id_metrics_pair() for top performing experiments
  • Add support for setting default value to auto connected argparse arguments
  • Add Task.get_script() and Task.set_script() for getting and setting task's script properties for execution
  • Add Task.mark_completed() force and status_message arguments
  • Add Task.stopped() reason argument
  • Add Task.query_tasks(), Task.get_task() and Task.get_tasks() tags argument

Bug Fixes

  • Fix PyJWT resiliency support
  • Fix xgb train overload ClearML GitHub issue #456
  • Fix http:// throws OSError in Windows by using pathlib2 instead of os ClearML GitHub issue #463
  • Fix local diff should include staged commits, otherwise applying git diff fails ClearML GitHub issue #457
  • Fix task.upload_artifact non-standard dictionary will now revert to pickle ClearML GitHub issue #452
  • Fix S3BucketConfig.is_valid() for EC2 environments with use_credentials_chain ClearML GitHub issue #478
  • Fix audio classifier example when training with a custom dataset ClearML GitHub issue #484
  • Fix clearml-task diff was corrupted by Windows drive letter and separator ClearML GitHub issue #483
  • Fix TQDM "line cleanup" not using CR but rather arrow-up escape sequence
  • Fix task.connect(dict) value casting - if None is the default value, use backend stored type
  • Fix Jupyter notebook should always set Task as completed/stopped, never failed (exceptions are caught in interactive session)
  • Fix Pipeline support
    • Fix LocalClearmlJob setting failed status
    • Fix pipeline stopping all running steps
    • Fix nested pipeline component parent point to pipeline Task
    • Fix PipelineController.start() should not kill the process when done
    • Fix pipeline failing to create Step Task should cause the pipeline to be marked failed
    • Fix nested pipeline components missing pipeline tags
  • Fix images reported over history size were not sent if frequency was too high
  • Fix git detectors missing git repository without origin
  • Fix support for upload LazyEvalWrapper artifacts
  • Fix duplicate task dataset tags
  • Fix FileLock create target folder
  • Fix crash inside forked subprocess might leave SafeQueue in a locked state, causing task.close() to hang
  • Fix PyTorch distributed example TimeoutSocket issue in Windows
  • Fix broken Dataset.finalize()
  • Fix Python 3.5 compatibility

ClearML SDK 1.1.2

Bug Fix

  • Fix PyJWT issue (limit dependency to <2.2.0)

ClearML SDK 1.1.1

Bug Fixes

  • Fix Logger.report_image() throws warning
  • Fix TensorBoard add_image() not being reported

ClearML SDK 1.1.0

Breaking Changes
  • New PipelineController v2 was introduced. New constructor is not backwards compatible!
  • ClearML will no longer try to use the demo server by default (change this by setting the CLEARML_NO_DEFAULT_SERVER=0 environment variable)
  • Task.completed() was deprecated, use Task.mark_completed() instead


  • Add Task Trigger Scheduler
  • Add Task Cron Scheduler
  • Add PipelineController from function
  • Add PipelineDecorator (PipelineDecorator.pipeline and PipelineDecorator.component decorators for full custom pipeline logic)
  • Add xgboost auto metric logging ClearML GitHub issue #381
  • Add and configuration options to control upload/download log reporting ClearML GitHub issue #424
  • Add new optional auto_connect_frameworks argument value to Task.init() (e.g. auto_connect_frameworks={'tfdefines':False}) to allow disabling TF defines ClearML GitHub issue #408
  • Add support for CLEARNL_CONFIG_VERBOSE environment variable to allow external control over verbosity of the configuration loading process
  • Add support for uploading artifacts with a list of files using Task.upload_artifcats(name, [Path(), Path()])
  • Add missing clearml-task parameters --docker_args, --docker_bash_setup_script and --output-uri
  • Change CreateAndPopulate will auto list packages imported but not installed locally
  • Add clearml.task.populate.create_task_from_function() to create a Task from a function, wrapping function input arguments into hyper-parameter section as kwargs and storing function results as named artifacts
  • Add support for Task serialization (e.g. for pickle)
  • Add Task.get_configuration_object_as_dict()
  • Add docker_image argument to Task.set_base_docker() (deprecate docker_cmd)
  • Add auto_version_bump argument to PipelineController
  • Add sdk.development.detailed_import_report configuration option to provide a detailed report of all python package imports
  • Set current Task as Dataset parent when creating dataset
  • Add support for deferred configuration
  • Examples
    • Add Pipeline v2 examples
    • Add TaskScheduler and TriggerScheduler examples
    • Add pipeline controller callback example
    • Improve existing examples and docstrings

Bug Fixes

ClearML Agent 1.1.0

Breaking Changes

ClearML Agent will no longer try to use the demo server by default (change this by setting the CLEARML_NO_DEFAULT_SERVER=0 environment variable)

ClearML k8s glue default pod label was changed to CLEARML=agent (instead of TRAINS=agent)


  • Add poetry cache into docker mapping ClearML Agent GitHub issue #74
  • Allow rewriting SSH URLs (see here), refers to ClearML Agent GitHub PR #72, ClearML Agent GitHub issue #42
  • Add docker environment arguments log masking support, customizable using the agent.hide_docker_command_env_vars configuration value (see here) ClearML Agent GitHub issue #67
  • Add support for naming docker containers using the agent.docker_container_name_format configuration option to set a name format (disabled by default) ClearML issue #412
  • k8s glue
    • Remove queue name from pod name, add queue name and ID to pod labels ClearML Agent GitHub issue #64
    • Update task status_message for non-responsive or hanging pods
    • Support the agent.docker_force_pull configuration option for scheduled pods
    • Add docker example for running the k8s glue as a pod in a k8s cluster
  • Add agent.ignore_requested_python_version configuration option to ignore any requested python version (default false, see here)
  • Add agent.docker_internal_mounts configuration option to control containers internal mounts (non-root containers, see here)
  • Add support for -r requirements.txt in the Installed Packages section
  • Add support for CLEARML_AGENT_INITIAL_CONNECT_RETRY_OVERRIDE environment variable to override initial server connection behavior (defaults to true, allows boolean value or an explicit number specifying the number of connect retries)
  • Add support for CLEARML_AGENT_DISABLE_SSH_MOUNT environment variable allowing to disable the auto .ssh mount into the docker
  • Add support for CLEARML_AGENT_SKIP_PIP_VENV_INSTALL environment variable to skip Python virtual env installation on execute and allow providing a custom venv binary
  • Add support for CLEARML_AGENT_VENV_CACHE_PATH environment variable to allow overriding venv cache folder configuration
  • Add support for CLEARML_AGENT_EXTRA_DOCKER_ARGS environment variable to allow overriding extra docker args configuration
  • Add support for environment variables containing bash-style string lists using shlex
  • Add printout when using ClearML key/secret from environment variables
  • Increase worker keep-alive timeout to 10 minutes instead of 1 minute
  • Update documentation

Bug Fixes

  • Fix auto mount SSH_AUTH_SOCK into docker ClearML Agent GitHub issue #45
  • Fix package manager configuration documentation ClearML Agent GitHub issue #78
  • Fix support for spaces in docker arguments ClearML GitHub issue #358
  • Fix standalone script with pre-exiting conda venv
  • Fix PyYAML v5.4, v5.4.1 versions not supported
  • Fix parsing VCS links starting with [email protected] (notice git+git:// was already supported)
  • Fix Python package with git+git:// links or git+ssh:// conversion
  • Fix --services-mode if the execute agent fails when starting to run with error code 0
  • Fix --stop with dynamic gpus
  • Fix support for unicode standalone scripts, changing default ascii encoding to UTF-8
  • Fix venv cache cannot reinstall package from git with http credentials
  • Fix PYTHONIOENCODING environment variable is overwritten when already defined
  • k8s glue
    • Fix support for multiple k8s glue instances with pod limits
    • Fix task container handling fails parsing docker image
    • Fix task container is not set when using default image/arguments
    • Fix task container image arguments are used when no image is specified
    • Fix task container arguments not supported in when template is not provided
    • Fix agent.extra_docker_bash_script not applied correctly
    • Fix task runtime properties are removed when re-enqueuing task
    • Fix error is not thrown when failing to push task to queue

ClearML Server 1.1.1

Bug Fixes

ClearML Server 1.1.0

New Features and Improvements

  • Add metric snapshot plot to project overview UI - Show an aggregated view of all project experiments value for a leading metric
  • Add logical AND option to UI experiment table tag filter
  • Add Task runtime properties to experiment INFO UI tab
  • Add full screen view for any experiment result plot
  • Add extended version information to UI profile page
  • Stop using special characters in secrets
  • Allow setting status_message in tasks.update
  • Improve UI table view configuration persistence - User table-view configuration is saved per project:
    • Visible columns
    • Column order
    • Column width
    • Active sort
    • Active filters

Bug Fixes

  • Fix experiment details UI failure opening hyperparameter sections beginning with # ClearML Server GitHub issue #79
  • Fix performance issues with UI comparison of large experiments Slack Channel
  • Fix filtering on hyperparameters ClearML GitHub issue #385 Slack Channel
  • Fix profile page user options toggle control area of effect
  • Fix browser resizing affecting plot zoom
  • Fix UI dataview filter resetting version on filter addition
  • Fix UI project overview:
    • Fix links in project overview not working
    • Allow editing empty overview for legacy projects
  • Fix Table plots using fraction of available space
  • Fix scalars color assignment broken by . in scalar name
  • Fix tasks cannot be moved between queues
  • Fix UI Docker argument input - Force arguments in designated field
  • Fix extraneous "tag" string prefixing Commit ID in Task execution information UI
  • Fix missing 'no value' option in hyperparameters table filters
  • Fix queued task is not dequeued on tasks.stop
  • General aesthetic fixes:
    • Fix input title alignment in UI clone experiment window
    • Fix UI empty experiment table message alignment
    • Fix UI table filter menu proportions
    • Fix debug sample dropdown menu coloring
    • Fix dashboard card alignment
    • Fix redundant separator in plot control when maximized