diff --git a/docs/release_notes/ver_1_0.md b/docs/release_notes/ver_1_0.md index 6445edb3..c4525004 100644 --- a/docs/release_notes/ver_1_0.md +++ b/docs/release_notes/ver_1_0.md @@ -28,8 +28,8 @@ This release is not backwards compatible **Features** -- Add Click support [ClearML GitHub issue #386](https://github.com/allegroai/clearml/issues/386) -- Add progress bar to SHA2 generation [ClearML GitHub issue #396](https://github.com/allegroai/clearml/issues/396) +- Add Click support ([ClearML GitHub issue #386](https://github.com/allegroai/clearml/issues/386)) +- Add progress bar to SHA2 generation ([ClearML GitHub issue #396](https://github.com/allegroai/clearml/issues/396)) - Add prefix to Task reported runtime info: `cpu_cores`, `gpu_driver_version` and `gpu_driver_cuda_version` - Add support for `Logger.report_text()` explicit log-level reporting - Add `return_full_path` argument to `StorageManager.list()` @@ -44,8 +44,8 @@ This release is not backwards compatible **Bug Fixes** -- Fix Pandas with multi-index [ClearML GitHub issue #399](https://github.com/allegroai/clearml/issues/399) -- Fix check permissions fail in `HTTPDriver` [ClearML GitHub issue #394](https://github.com/allegroai/clearml/issues/394) +- Fix Pandas with multi-index ([ClearML GitHub issue #399](https://github.com/allegroai/clearml/issues/399)) +- Fix check permissions fail in `HTTPDriver` ([ClearML GitHub issue #394](https://github.com/allegroai/clearml/issues/394)) - Fix Dataset not setting system tag on existing `data_processing` Tasks - Fix disable redundant resource monitoring in pipeline controller - Fix `ClearMLJob` when both `project` and `target_project` are specified @@ -60,17 +60,17 @@ This release is not backwards compatible **Features** -- Add Google Colab notebook tutorial [ClearML GitHub PR 368](https://github.com/allegroai/clearml/issues/368) [ClearML GitHub PR 374](https://github.com/allegroai/clearml/issues/374) -- Add support for GIF images in Tensorboard [ClearML GitHub issue 372](https://github.com/allegroai/clearml/issues/372) -- Add a tensorboardX example for `add_video` (creates GIFs in tensorboard) [ClearML GitHub PR 372](https://github.com/allegroai/clearml/issues/372) +- Add Google Colab notebook tutorial ([ClearML GitHub PR 368](https://github.com/allegroai/clearml/issues/368) [ClearML GitHub PR 374](https://github.com/allegroai/clearml/issues/374)) +- Add support for GIF images in Tensorboard ([ClearML GitHub issue 372](https://github.com/allegroai/clearml/issues/372)) +- Add a tensorboardX example for `add_video` (creates GIFs in tensorboard) ([ClearML GitHub PR 372](https://github.com/allegroai/clearml/issues/372)) - Add auto scaler customizable boot bash script - Add `Task.ignore_requirements` - Deprecate `Logger.tensorboard_single_series_per_graph()` as it is now controlled from the UI 🙂 **Bug Fixes** -- Fix `default_output_uri` for Dataset creation [ClearML GitHub issue 371](https://github.com/allegroai/clearml/issues/371) -- Fix `clearml-task` failing without a docker script [ClearML GitHub issue 378](https://github.com/allegroai/clearml/issues/378) +- Fix `default_output_uri` for Dataset creation ([ClearML GitHub issue 371](https://github.com/allegroai/clearml/issues/371)) +- Fix `clearml-task` failing without a docker script ([ClearML GitHub issue 378](https://github.com/allegroai/clearml/issues/378)) - Fix PyTorch DDP sub-process spawn multi-process - Fix `Task.execute_remotely()` on created Task (not initialized Task) - Fix auto scaler custom bash script should be called last before starting agent @@ -81,8 +81,8 @@ This release is not backwards compatible **Features** -- Use default `boto` credential chain if no keys are provided in the configuration file or environment variables [ClearML GitHub PR 342](https://github.com/allegroai/clearml/issues/342) -- Support `DummyModel` configuration [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1621469235085400) +- Use default `boto` credential chain if no keys are provided in the configuration file or environment variables ([ClearML GitHub PR 342](https://github.com/allegroai/clearml/issues/342)) +- Support `DummyModel` configuration ([Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1621469235085400)) - Add `report_matplotlib_figure(..., report_interactive=False)` allowing to upload a matplotlib as a non-interactive (high quality png) plot - Add `Logger.matplotlib_force_report_non_interactive()` - Remove matplotlib axis range (`plotly.js` auto-range can adjust it in real-time) @@ -98,10 +98,10 @@ This release is not backwards compatible **Bug Fixes** -- Fix Hydra should not store the full resolved OmegaConf [ClearML GitHub issue 327](https://github.com/allegroai/clearml/issues/327) -- Fix direct import of keras save/load model functions [ClearML GitHub issue 355](https://github.com/allegroai/clearml/issues/355) -- Fix run as module [ClearML GitHub issue 359](https://github.com/allegroai/clearml/issues/359) -- Fix Python 2.7 support [ClearML GitHub issue 366](https://github.com/allegroai/clearml/issues/366) +- Fix Hydra should not store the full resolved OmegaConf ([ClearML GitHub issue 327](https://github.com/allegroai/clearml/issues/327)) +- Fix direct import of keras save/load model functions ([ClearML GitHub issue 355](https://github.com/allegroai/clearml/issues/355)) +- Fix run as module ([ClearML GitHub issue 359](https://github.com/allegroai/clearml/issues/359)) +- Fix Python 2.7 support ([ClearML GitHub issue 366](https://github.com/allegroai/clearml/issues/366)) - Fix `Task.add_requirements()` passing `package_version` starting with `@`, `;` or `#` - Fix import keras from TF - Fix support for Hydra's `run_job()` change in parameter order by passing `config` and `task_function` as keyword arguments @@ -120,7 +120,7 @@ This release is not backwards compatible **Bug Fixes** -- Fix Task container does not accept `null` values [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1622119047293300) [ClearML GitHub issue 365](https://github.com/allegroai/clearml/issues/365) +- Fix Task container does not accept `null` values ([Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1622119047293300) [ClearML GitHub issue 365](https://github.com/allegroai/clearml/issues/365)) - Fix debug images exception in Results page - Fix a typo in Worker Setup help popup @@ -129,8 +129,8 @@ This release is not backwards compatible **Bug Fixes** - Fix clearing experiment requirements causes "empty" requirements (as opposed to "no requirements") -- Fix logout fails with `endpoint not found` error [ClearML GitHub issue 349](https://github.com/allegroai/clearml/issues/349) -- Fix hamburger side menu `Manage Queues` does nothing and returns console error [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1620308724418100) +- Fix logout fails with `endpoint not found` error ([ClearML GitHub issue 349](https://github.com/allegroai/clearml/issues/349)) +- Fix hamburger side menu `Manage Queues` does nothing and returns console error ([Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1620308724418100)) - Fix broken config dir backwards compatibility (`/opt/trains/config` should also be supported) ### ClearML 1.0.2 @@ -153,10 +153,10 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` **Features** -* Add OS environment variable `CLEARML_DEFAULT_OUTPUT_URI` to override default `output_uri` for automatic models upload - [ClearML GitHub issue 328](https://github.com/allegroai/clearml/issues/328) -* Add `Task.force_requirements_env_freeze()` forcing `pip freeze` instead of package analysis - [ClearML GitHub issue 304](https://github.com/allegroai/clearml/issues/304) +* Add OS environment variable `CLEARML_DEFAULT_OUTPUT_URI` to override default `output_uri` for automatic models upload ([ClearML GitHub issue 328](https://github.com/allegroai/clearml/issues/328)) +* Add `Task.force_requirements_env_freeze()` forcing `pip freeze` instead of package analysis ([ClearML GitHub issue 304](https://github.com/allegroai/clearml/issues/304)) * Improve pipeline support - * Add Task parameters override in `ClearmlJob` - [ClearML GitHub issue 214](https://github.com/allegroai/clearml/issues/214) + * Add Task parameters override in `ClearmlJob` ([ClearML GitHub issue 214](https://github.com/allegroai/clearml/issues/214)) * Add PipelineController node skip visualization and pre/post-execution callback * Allow enabling/disabling tensorboard auto-connect using `Task.init(auto_connect_frameworks={'tensorboard': True/False})` (default: `True`) * Allow to continue running from previous execution iteration @@ -186,9 +186,9 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` **Bug Fixes** -* Fix `\r` and `\n` in debug samples title/series - [ClearML GitHub issue 323](https://github.com/allegroai/clearml/issues/323) -* Fix Google API credentials without storage section raises exception on import - [ClearML GitHub issue 331](https://github.com/allegroai/clearml/issues/331) -* Fix Matplotlib automagic export legend not showing series names - [ClearML GitHub issue 337](https://github.com/allegroai/clearml/issues/337) +* Fix `\r` and `\n` in debug samples title/series ([ClearML GitHub issue 323](https://github.com/allegroai/clearml/issues/323)) +* Fix Google API credentials without storage section raises exception on import ([ClearML GitHub issue 331](https://github.com/allegroai/clearml/issues/331)) +* Fix Matplotlib automagic export legend not showing series names ([ClearML GitHub issue 337](https://github.com/allegroai/clearml/issues/337)) * Fix `Task.set_comment/name()` passing `None` should be equivalent to `''` * Fix `Task.set_credentials()` uses incorrect config file when both `trains.conf` and `clearml.conf` are found * Fix `Task.set_credetnials()` should override settings from config file @@ -230,8 +230,8 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` **Bug Fixes** -* Fix agent can return non-zero error code and pods will end up restarting forever - [clearml-agent GitHub Issue 56](https://github.com/allegroai/clearml-agent/issues/56) -* Fix poetry support - [clearml-agent GitHub Issue 57](https://github.com/allegroai/clearml-agent/issues/57) +* Fix agent can return non-zero error code and pods will end up restarting forever ([clearml-agent GitHub Issue 56](https://github.com/allegroai/clearml-agent/issues/56)) +* Fix poetry support ([clearml-agent GitHub Issue 57](https://github.com/allegroai/clearml-agent/issues/57)) * Fix cuda version from driver does not return minor version * Fix requirements local path replace back when using cache * Fix k8s glue @@ -247,12 +247,12 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` * Add Multi-level project hierarchy - Projects can now contain sub-projects * Add markdown editor for project overview * Add support for multiple models per experiment -* Add Context menu batch operations - [ClearML GitHub issue 286](https://github.com/allegroai/clearml/issues/286) -* Add global search regex support - [ClearML GitHub issue 81](https://github.com/allegroai/clearml/issues/81#issuecomment-735003956) +* Add Context menu batch operations ([ClearML GitHub issue 286](https://github.com/allegroai/clearml/issues/286)) +* Add global search regex support ([ClearML GitHub issue 81](https://github.com/allegroai/clearml/issues/81#issuecomment-735003956)) * Add support for extended container (docker) configuration and init script * Add special character support ("." (dot) and "$") in Hyperparameters * Add new context menu icons -* Add deleting experiments and models through UI - ClearML GitHub issues [53](https://github.com/allegroai/clearml-server/issues/53), [61](https://github.com/allegroai/clearml-server/issues/61) and [81](https://github.com/allegroai/clearml/issues/81#issuecomment-706907718) +* Add deleting experiments and models through UI (ClearML GitHub issues [53](https://github.com/allegroai/clearml-server/issues/53), [61](https://github.com/allegroai/clearml-server/issues/61) and [81](https://github.com/allegroai/clearml/issues/81#issuecomment-706907718)) * Improve Project deletion: deletes project's experiments and models. * Add experiment description access from info title * Improve experiment table columns @@ -262,7 +262,7 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` * Add secondary nested sorting * Add worker<->queue clickable reference in workers and queues tables * Add presenting all metric debug samples concurrently -* Add Full project name display in project cards - [ClearML GitHub issue 81](https://github.com/allegroai/clearml/issues/81#issuecomment-823303842) +* Add Full project name display in project cards ([ClearML GitHub issue 81](https://github.com/allegroai/clearml/issues/81#issuecomment-823303842)) * Add option for continuing aborted tasks **Bug Fixes** @@ -275,15 +275,15 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` * Fix UI missing default selection of artifacts in full screen view * Fix UI variant name not shown in plots * Fix UI missing tooltip for truncated column headers -* Fix UI custom columns choice does not persist per project - [ClearML GitHub issue 314](https://github.com/allegroai/clearml/issues/314) +* Fix UI custom columns choice does not persist per project ([ClearML GitHub issue 314](https://github.com/allegroai/clearml/issues/314)) * Fix API plot_str not returned for compressed plots * Fix UI plots color picker consistency * Fix API ```Tasks.reset``` marking parent id as 'deleted' in its children * Fix UI missing queue selection on queue delete * Fix UI debug image history slider not shown when there's only a single iteration -* Fix UI X-axis labels are being cut in plots - [ClearML GitHub issue 264](https://github.com/allegroai/clearml/issues/264) +* Fix UI X-axis labels are being cut in plots ([ClearML GitHub issue 264](https://github.com/allegroai/clearml/issues/264)) * Fix UI scalar color choice dialog toggles between screen positions every time you open it -* Fix UI hovering on legend clears parallel coordinates graph filters - [ClearML GitHub issue 259](https://github.com/allegroai/clearml/issues/259) +* Fix UI hovering on legend clears parallel coordinates graph filters ([ClearML GitHub issue 259](https://github.com/allegroai/clearml/issues/259)) * Fix UI experiment comparison 'hide identical fields' button disable doesn't work * Fix UI auto refresh removes model ID in model panel * Fix UI debug samples download image opens new tab instead of downloading diff --git a/docs/release_notes/ver_1_1.md b/docs/release_notes/ver_1_1.md index a23b8e2a..7fe64b20 100644 --- a/docs/release_notes/ver_1_1.md +++ b/docs/release_notes/ver_1_1.md @@ -31,7 +31,7 @@ This release is not backwards compatible - see notes below on upgrading **Features** -- Add `Task.force_store_standalone_script()` to force storing standalone script instead of a Git repository reference [ClearML GitHub issue #340](https://github.com/allegroai/clearml/issues/340) +- Add `Task.force_store_standalone_script()` to force storing standalone script instead of a Git repository reference ([ClearML GitHub issue #340](https://github.com/allegroai/clearml/issues/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 @@ -40,8 +40,8 @@ This release is not backwards compatible - see notes below on upgrading **Bug Fixes** -- Fix and upgrade the SlackMonitor [ClearML GitHub issue #533](https://github.com/allegroai/clearml/issues/533) -- Fix network issues causing Task to stop on status change when no status change has occurred [ClearML GitHub issue #535](https://github.com/allegroai/clearml/issues/535) +- Fix and upgrade the SlackMonitor ([ClearML GitHub issue #533](https://github.com/allegroai/clearml/issues/533)) +- Fix network issues causing Task to stop on status change when no status change has occurred ([ClearML GitHub issue #535](https://github.com/allegroai/clearml/issues/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 @@ -57,16 +57,16 @@ This release is not backwards compatible - see notes below on upgrading ### ClearML SDK 1.1.5 **Features** -* Add support for `jsonargpraser` [ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403) +* Add support for `jsonargpraser` ([ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403)) * Add `HyperParameterOptimizer.get_top_experiments_details()` returns the hparams and metrics of the top performing - experiments of an HPO [ClearML GitHub issue #473](https://github.com/allegroai/clearml/issues/473) + experiments of an HPO ([ClearML GitHub issue #473](https://github.com/allegroai/clearml/issues/473)) * Allow overriding initial iteration offset using environment variable (`CLEARML_SET_ITERATION_OFFSET`) or `Task.init(continue_last_task==)` - [ClearML GitHub issue #496](https://github.com/allegroai/clearml/issues/496) -* Add better input handling for `clearml-init` in colab [ClearML GitHub issue #515](https://github.com/allegroai/clearml/issues/515) -* Add environment variable for default request method [ClearML GitHub issue #521](https://github.com/allegroai/clearml/issues/521) -* Add `LocalClearmlJob` as possible option for HPO [ClearML GitHub issue #525](https://github.com/allegroai/clearml/issues/525) -* Add convenience functionality to `clearml-data` [ClearML GitHub issue #526](https://github.com/allegroai/clearml/issues/526) -* Add support for `vscode-jupyter` [microsoft/vscode-jupyter#8531](https://github.com/microsoft/vscode-jupyter/pull/8531) + ( [ClearML GitHub issue #496](https://github.com/allegroai/clearml/issues/496)) +* Add better input handling for `clearml-init` in colab ([ClearML GitHub issue #515](https://github.com/allegroai/clearml/issues/515)) +* Add environment variable for default request method ([ClearML GitHub issue #521](https://github.com/allegroai/clearml/issues/521)) +* Add `LocalClearmlJob` as possible option for HPO ([ClearML GitHub issue #525](https://github.com/allegroai/clearml/issues/525)) +* Add convenience functionality to `clearml-data` ([ClearML GitHub issue #526](https://github.com/allegroai/clearml/issues/526)) +* Add support for `vscode-jupyter` ([microsoft/vscode-jupyter#8531](https://github.com/microsoft/vscode-jupyter/pull/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) @@ -84,21 +84,21 @@ This release is not backwards compatible - see notes below on upgrading * Add `PipelineDecorator.multi_instance_support` * Add `PipelineDecorator` to `clearml` and `clearml.automation` namespaces * Documentation and examples - * Update docstrings [ClearML GitHub issue #501](https://github.com/allegroai/clearml/issues/501) - * Add Markdown in pipeline jupyter notebooks [ClearML GitHub issue #502](https://github.com/allegroai/clearml/issues/502) - * Update pipeline example [ClearML GitHub issue #494](https://github.com/allegroai/clearml/issues/494) - * Add abseil example [ClearML GitHub issue #509](https://github.com/allegroai/clearml/issues/509) - * Change README to dark theme [ClearML GitHub issue #513](https://github.com/allegroai/clearml/issues/513) - * Update XGBoost example [ClearML GitHub issue #524](https://github.com/allegroai/clearml/issues/524) - * Change example name [ClearML GitHub issue #528](https://github.com/allegroai/clearml/issues/528) + * Update docstrings ([ClearML GitHub issue #501](https://github.com/allegroai/clearml/issues/501)) + * Add Markdown in pipeline jupyter notebooks ([ClearML GitHub issue #502](https://github.com/allegroai/clearml/issues/502)) + * Update pipeline example ([ClearML GitHub issue #494](https://github.com/allegroai/clearml/issues/494)) + * Add abseil example ([ClearML GitHub issue #509](https://github.com/allegroai/clearml/issues/509)) + * Change README to dark theme ([ClearML GitHub issue #513](https://github.com/allegroai/clearml/issues/513)) + * Update XGBoost example ([ClearML GitHub issue #524](https://github.com/allegroai/clearml/issues/524)) + * Change example name ([ClearML GitHub issue #528](https://github.com/allegroai/clearml/issues/528)) **Bug Fixes** -* Fix `TriggerScheduler` on Dataset change [ClearML GitHub issue #491](https://github.com/allegroai/clearml/issues/491) -* Fix links in Jupyter Notebooks [ClearML GitHub issue #505](https://github.com/allegroai/clearml/issues/505) -* Fix `pandas` delta datetime conversion [ClearML GitHub issue #510](https://github.com/allegroai/clearml/issues/510) -* Fix `matplotlib` auto-magic detect bar graph series name [ClearML GitHub issue #518](https://github.com/allegroai/clearml/issues/518) +* Fix `TriggerScheduler` on Dataset change ([ClearML GitHub issue #491](https://github.com/allegroai/clearml/issues/491)) +* Fix links in Jupyter Notebooks ([ClearML GitHub issue #505](https://github.com/allegroai/clearml/issues/505)) +* Fix `pandas` delta datetime conversion ([ClearML GitHub issue #510](https://github.com/allegroai/clearml/issues/510)) +* Fix `matplotlib` auto-magic detect bar graph series name ([ClearML GitHub issue #518](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/516) + project name (full path) and task name used for object path ([ClearML GitHub issue #516](https://github.com/allegroai/clearml/issues/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 @@ -125,8 +125,8 @@ This release is not backwards compatible - see notes below on upgrading **Bug Fixes** -- Fix duplicate keyword argument (affects `clearml-data`, `Dataset.get()`) [ClearML GitHub issue #490](https://github.com/allegroai/clearml/issues/490) -- Fix session raises missing host error when in offline mode [ClearML GitHub issue #489](https://github.com/allegroai/clearml/issues/489) +- Fix duplicate keyword argument (affects `clearml-data`, `Dataset.get()`) ([ClearML GitHub issue #490](https://github.com/allegroai/clearml/issues/490)) +- Fix session raises missing host error when in offline mode ([ClearML GitHub issue #489](https://github.com/allegroai/clearml/issues/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` @@ -138,7 +138,7 @@ This release is not backwards compatible - see notes below on upgrading - 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](https://github.com/allegroai/clearml-agent/issues/80) +- Fix `--stop` checking default queue tag ([ClearML Agent GitHub issue #80](https://github.com/allegroai/clearml-agent/issues/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 @@ -147,11 +147,11 @@ This release is not backwards compatible - see notes below on upgrading **Features** -- Add support for MegEngine with examples [ClearML GitHub issue #455](https://github.com/allegroai/clearml/issues/455) -- Add `TaskTypes` to main namespace [ClearML GitHub issue #453](https://github.com/allegroai/clearml/issues/453) -- Add `LogUnifomParameterRange` for hyperparameter optimization with Optuna [ClearML GitHub issue #462](https://github.com/allegroai/clearml/issues/462) +- Add support for MegEngine with examples ([ClearML GitHub issue #455](https://github.com/allegroai/clearml/issues/455)) +- Add `TaskTypes` to main namespace ([ClearML GitHub issue #453](https://github.com/allegroai/clearml/issues/453)) +- Add `LogUnifomParameterRange` for hyperparameter optimization with Optuna ([ClearML GitHub issue #462](https://github.com/allegroai/clearml/issues/462)) - Add joblib (equivalent to scikit) to `Task.init(auto_connect_frameworks)` argument -- Log environment variables starting with `*` in `environ_bind.py` [ClearML GitHub issue #459](https://github.com/allegroai/clearml/issues/459) +- Log environment variables starting with `*` in `environ_bind.py` ([ClearML GitHub issue #459](https://github.com/allegroai/clearml/issues/459)) - Pipeline - Add eager decorated pipeline execution - Support pipeline monitoring for scalars/models/artifacts @@ -178,13 +178,13 @@ This release is not backwards compatible - see notes below on upgrading **Bug Fixes** - Fix PyJWT resiliency support -- Fix xgb train overload [ClearML GitHub issue #456](https://github.com/allegroai/clearml/issues/456) -- Fix `http://` throws `OSError` in Windows by using `pathlib2` instead of `os` [ClearML GitHub issue #463](https://github.com/allegroai/clearml/issues/463) -- Fix local diff should include staged commits, otherwise applying git diff fails [ClearML GitHub issue #457](https://github.com/allegroai/clearml/issues/457) -- Fix `task.upload_artifact` non-standard dictionary will now revert to `pickle` [ClearML GitHub issue #452](https://github.com/allegroai/clearml/issues/452) -- Fix `S3BucketConfig.is_valid()` for EC2 environments with `use_credentials_chain` [ClearML GitHub issue #478](https://github.com/allegroai/clearml/issues/478) -- Fix audio classifier example when training with a custom dataset [ClearML GitHub issue #484](https://github.com/allegroai/clearml/issues/484) -- Fix `clearml-task` diff was corrupted by Windows drive letter and separator [ClearML GitHub issue #483](https://github.com/allegroai/clearml/issues/483) +- Fix xgb train overload ([ClearML GitHub issue #456](https://github.com/allegroai/clearml/issues/456)) +- Fix `http://` throws `OSError` in Windows by using `pathlib2` instead of `os` ([ClearML GitHub issue #463](https://github.com/allegroai/clearml/issues/463)) +- Fix local diff should include staged commits, otherwise applying git diff fails ([ClearML GitHub issue #457](https://github.com/allegroai/clearml/issues/457)) +- Fix `task.upload_artifact` non-standard dictionary will now revert to `pickle` ([ClearML GitHub issue #452](https://github.com/allegroai/clearml/issues/452)) +- Fix `S3BucketConfig.is_valid()` for EC2 environments with `use_credentials_chain` ([ClearML GitHub issue #478](https://github.com/allegroai/clearml/issues/478)) +- Fix audio classifier example when training with a custom dataset ([ClearML GitHub issue #484](https://github.com/allegroai/clearml/issues/484)) +- Fix `clearml-task` diff was corrupted by Windows drive letter and separator ([ClearML GitHub issue #483](https://github.com/allegroai/clearml/issues/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) @@ -232,9 +232,9 @@ This release is not backwards compatible - see notes below on upgrading - 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](https://github.com/allegroai/clearml/issues/381) -- Add `sdk.storage.log.report_upload_chunk_size_mb` and `sdk.storage.log.report_download_chunk_size_mb` configuration options to control upload/download log reporting [ClearML GitHub issue #424](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/408) +- Add xgboost auto metric logging ([ClearML GitHub issue #381](https://github.com/allegroai/clearml/issues/381)) +- Add `sdk.storage.log.report_upload_chunk_size_mb` and `sdk.storage.log.report_download_chunk_size_mb` configuration options to control upload/download log reporting ([ClearML GitHub issue #424](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/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` @@ -255,18 +255,18 @@ This release is not backwards compatible - see notes below on upgrading **Bug Fixes** -- Fix plotly plots converting `NaN` to `nan` instead of `null` [ClearML GitHub issue #373](https://github.com/allegroai/clearml/issues/373) -- Fix deprecation warning [ClearML GitHub issue #376](https://github.com/allegroai/clearml/issues/376) -- Fix plotly multi-index without index names [ClearML GitHub issue #399](https://github.com/allegroai/clearml/issues/399) -- Fix click support [ClearML GitHub issue #437](https://github.com/allegroai/clearml/issues/437) -- Fix docstring [ClearML GitHub issue #438](https://github.com/allegroai/clearml/issues/438) -- Fix passing `task-type` to *clearml-task* [ClearML GitHub issue #422](https://github.com/allegroai/clearml/issues/422) -- Fix `clearml-task --version` throws an error [ClearML GitHub issue #422](https://github.com/allegroai/clearml/issues/422) -- Fix *clearml-task* ssh repository links are not detected as remote repositories [ClearML GitHub issue #423](https://github.com/allegroai/clearml/issues/423) -- Fix `getattr` throws an exception [ClearML GitHub issue #426](https://github.com/allegroai/clearml/issues/426) -- Fix encoding while saving notebook preview [ClearML GitHub issue #443](https://github.com/allegroai/clearml/issues/443) -- Fix poetry toml file without requirements.txt [ClearML GitHub issue #444](https://github.com/allegroai/clearml/issues/444) -- Fix `PY3.x` fails calling `SemLock._after_fork` with forkserver context, forking while lock is acquired [ClearML Agent GitHub issue #73](https://github.com/allegroai/clearml-agent/issues/73) +- Fix plotly plots converting `NaN` to `nan` instead of `null` ([ClearML GitHub issue #373](https://github.com/allegroai/clearml/issues/373)) +- Fix deprecation warning ([ClearML GitHub issue #376](https://github.com/allegroai/clearml/issues/376)) +- Fix plotly multi-index without index names ([ClearML GitHub issue #399](https://github.com/allegroai/clearml/issues/399)) +- Fix click support ([ClearML GitHub issue #437](https://github.com/allegroai/clearml/issues/437)) +- Fix docstring ([ClearML GitHub issue #438](https://github.com/allegroai/clearml/issues/438)) +- Fix passing `task-type` to *clearml-task* ([ClearML GitHub issue #422](https://github.com/allegroai/clearml/issues/422)) +- Fix `clearml-task --version` throws an error ([ClearML GitHub issue #422](https://github.com/allegroai/clearml/issues/422)) +- Fix *clearml-task* ssh repository links are not detected as remote repositories ([ClearML GitHub issue #423](https://github.com/allegroai/clearml/issues/423)) +- Fix `getattr` throws an exception ([ClearML GitHub issue #426](https://github.com/allegroai/clearml/issues/426)) +- Fix encoding while saving notebook preview ([ClearML GitHub issue #443](https://github.com/allegroai/clearml/issues/443)) +- Fix poetry toml file without requirements.txt ([ClearML GitHub issue #444](https://github.com/allegroai/clearml/issues/444)) +- Fix `PY3.x` fails calling `SemLock._after_fork` with forkserver context, forking while lock is acquired ([ClearML Agent GitHub issue #73](https://github.com/allegroai/clearml-agent/issues/73)) - Fix wrong download path in `StorageManager.download_folder()` - Fix jupyter notebook `display(...)` convert to `print(...)` - Fix TensorFlow `add_image()` with `description='text'` @@ -292,12 +292,12 @@ ClearML k8s glue default pod label was changed to `CLEARML=agent` (instead of `T **Features** -- Add poetry cache into docker mapping [ClearML Agent GitHub issue #74](https://github.com/allegroai/clearml-agent/issues/74) -- Allow rewriting SSH URLs (see [here](https://github.com/allegroai/clearml-agent/commit/9456e493ac6d6495310ee084db906f9cdca8218c)), refers to [ClearML Agent GitHub PR #72](https://github.com/allegroai/clearml-agent/pull/72), [ClearML Agent GitHub issue #42](https://github.com/allegroai/clearml-agent/issues/42) -- Add docker environment arguments log masking support, customizable using the `agent.hide_docker_command_env_vars` configuration value (see [here](https://github.com/allegroai/clearml-agent/blob/db57441c5dda43d8e38f01d7f52f047913e95ba5/docs/clearml.conf#L172)) [ClearML Agent GitHub issue #67](https://github.com/allegroai/clearml-agent/issues/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](https://github.com/allegroai/clearml/issues/412) +- Add poetry cache into docker mapping ([ClearML Agent GitHub issue #74](https://github.com/allegroai/clearml-agent/issues/74)) +- Allow rewriting SSH URLs (see [here](https://github.com/allegroai/clearml-agent/commit/9456e493ac6d6495310ee084db906f9cdca8218c)), refers to [ClearML Agent GitHub PR #72](https://github.com/allegroai/clearml-agent/pull/72) ([ClearML Agent GitHub issue #42](https://github.com/allegroai/clearml-agent/issues/42)) +- Add docker environment arguments log masking support, customizable using the `agent.hide_docker_command_env_vars` configuration value (see [here](https://github.com/allegroai/clearml-agent/blob/db57441c5dda43d8e38f01d7f52f047913e95ba5/docs/clearml.conf#L172)) ([ClearML Agent GitHub issue #67](https://github.com/allegroai/clearml-agent/issues/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](https://github.com/allegroai/clearml/issues/412)) - k8s glue - - Remove queue name from pod name, add queue name and ID to pod labels [ClearML Agent GitHub issue #64](https://github.com/allegroai/clearml-agent/issues/64) + - Remove queue name from pod name, add queue name and ID to pod labels ([ClearML Agent GitHub issue #64](https://github.com/allegroai/clearml-agent/issues/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 @@ -316,9 +316,9 @@ ClearML k8s glue default pod label was changed to `CLEARML=agent` (instead of `T **Bug Fixes** -- Fix auto mount `SSH_AUTH_SOCK` into docker [ClearML Agent GitHub issue #45](https://github.com/allegroai/clearml-agent/issues/45) -- Fix package manager configuration documentation [ClearML Agent GitHub issue #78](https://github.com/allegroai/clearml-agent/issues/78) -- Fix support for spaces in docker arguments [ClearML GitHub issue #358](https://github.com/allegroai/clearml/issues/358) +- Fix auto mount `SSH_AUTH_SOCK` into docker ([ClearML Agent GitHub issue #45](https://github.com/allegroai/clearml-agent/issues/45)) +- Fix package manager configuration documentation ([ClearML Agent GitHub issue #78](https://github.com/allegroai/clearml-agent/issues/78)) +- Fix support for spaces in docker arguments ([ClearML GitHub issue #358](https://github.com/allegroai/clearml/issues/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 `git+git@` (notice `git+git://` was already supported) @@ -342,9 +342,9 @@ ClearML k8s glue default pod label was changed to `CLEARML=agent` (instead of `T **Bug Fixes** -- Fix experiment plots override reported color-scale [ClearML GitHub issue #373](https://github.com/allegroai/clearml/issues/373), [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1627310354415200) -- Fix file server `GET` response for gzipped data-files contains `Content-Encoding: gz` header, causing clients to automatically decompress the file [ClearML GitHub issue #411](https://github.com/allegroai/clearml/issues/411) -- Fix server error when running with non-migrated v0.16 ElasticSearch data [Slack Channel](https://clearml.slack.com/archives)/CTK20V944/p1627911579075600 +- Fix experiment plots override reported color-scale ([ClearML GitHub issue #373](https://github.com/allegroai/clearml/issues/373), [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1627310354415200)) +- Fix file server `GET` response for gzipped data-files contains `Content-Encoding: gz` header, causing clients to automatically decompress the file ([ClearML GitHub issue #411](https://github.com/allegroai/clearml/issues/411)) +- Fix server error when running with non-migrated v0.16 ElasticSearch data ([Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1627911579075600)) ### ClearML Server 1.1.0 @@ -366,9 +366,9 @@ ClearML k8s glue default pod label was changed to `CLEARML=agent` (instead of `T **Bug Fixes** -- Fix experiment details UI failure opening hyperparameter sections beginning with `#` [ClearML Server GitHub issue #79](https://github.com/allegroai/clearml-server/issues/79) -- Fix performance issues with UI comparison of large experiments [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1621698235159800) -- Fix filtering on hyperparameters [ClearML GitHub issue #385](https://github.com/allegroai/clearml/issues/385) [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1626600582284700) +- Fix experiment details UI failure opening hyperparameter sections beginning with `#` ([ClearML Server GitHub issue #79](https://github.com/allegroai/clearml-server/issues/79)) +- Fix performance issues with UI comparison of large experiments ([Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1621698235159800)) +- Fix filtering on hyperparameters ([ClearML GitHub issue #385](https://github.com/allegroai/clearml/issues/385) [Slack Channel](https://clearml.slack.com/archives/CTK20V944/p1626600582284700)) - 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 diff --git a/docs/release_notes/ver_1_10.md b/docs/release_notes/ver_1_10.md index 56642ed8..9dda7668 100644 --- a/docs/release_notes/ver_1_10.md +++ b/docs/release_notes/ver_1_10.md @@ -5,12 +5,12 @@ title: Version 1.10 ### ClearML SDK 1.10.4 **New Features and Improvements** -* Update references to `GetAllRequest` in Task docstrings [ClearML GitHub issue #981](https://github.com/allegroai/clearml/issues/981) +* Update references to `GetAllRequest` in Task docstrings ([ClearML GitHub issue #981](https://github.com/allegroai/clearml/issues/981)) **Bug Fixes** -* Fix issue with JSON conversion when using `jsonargparse` during remote execution [ClearML GitHub issue #1010](https://github.com/allegroai/clearml/issues/1010) -and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent/issues/153) -* Fix `ProxyDictPostWrite.update()` not triggering a write-back to the backend [ClearML GitHub issue #985](https://github.com/allegroai/clearml/issues/985) +* Fix issue with JSON conversion when using `jsonargparse` during remote execution ([ClearML GitHub issue #1010](https://github.com/allegroai/clearml/issues/1010) +and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent/issues/153)) +* Fix `ProxyDictPostWrite.update()` not triggering a write-back to the backend ([ClearML GitHub issue #985](https://github.com/allegroai/clearml/issues/985)) * Fix standard streams being patched in subtasks, which caused the streams to be reported to the wrong task * Fix TypeError when using `Task.query_tasks()` without specifying the `task_filter` parameter * Fix Tensorboard negative iterations, they are now zeroed @@ -20,7 +20,7 @@ and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent ### ClearML Server 1.10.1 **Bug Fix** -* Fix WebApp does not connect to the server when using non-default ports [ClearML Server GitHub issue #191](https://github.com/allegroai/clearml-server/issues/191) +* Fix WebApp does not connect to the server when using non-default ports ([ClearML Server GitHub issue #191](https://github.com/allegroai/clearml-server/issues/191)) ### ClearML SDK 1.10.3 @@ -30,14 +30,14 @@ and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent ### ClearML SDK 1.10.2 **New Features and Improvements** -* Allow task filtering with `Task.query_tasks()` using `TaskTypes` [ClearML GitHub issue #938](https://github.com/allegroai/clearml/issues/938) +* Allow task filtering with `Task.query_tasks()` using `TaskTypes` ([ClearML GitHub issue #938](https://github.com/allegroai/clearml/issues/938)) * Allow adding tags to individual pipeline steps and to the `PipelineController` * Restrict `Dataset.create()` usage for old server API versions * Improve docstrings **Bug Fixes** -* Fix `Task.get_tasks` docstring [ClearML GitHub issue #937](https://github.com/allegroai/clearml/issues/937) -* Fix `Task.get_reported_scalars()` docstring for `x_axis` parameter's `"timestamp"` value [ClearML GitHub issue #963](https://github.com/allegroai/clearml/issues/963) +* Fix `Task.get_tasks` docstring ([ClearML GitHub issue #937](https://github.com/allegroai/clearml/issues/937)) +* Fix `Task.get_reported_scalars()` docstring for `x_axis` parameter's `"timestamp"` value ([ClearML GitHub issue #963](https://github.com/allegroai/clearml/issues/963)) * Fix missing plots on models in Windows * Fix Pipeline version auto-bumping * Fix `APIClient.events.debug_images()` for latest server API version @@ -45,7 +45,7 @@ and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent ### ClearML SDK 1.10.1 **New Features and Improvements** -* Add cast parameter to Task.get_parameter method [ClearML GitHub issue #951](https://github.com/allegroai/clearml/issues/951) +* Add cast parameter to Task.get_parameter method ([ClearML GitHub issue #951](https://github.com/allegroai/clearml/issues/951)) **Bug Fixes** * Fix backward compatibility issue when using datetime filtering with `APIClient().models.get_all` and `APIClient().tasks.get_all` requests @@ -55,13 +55,13 @@ and [ClearML Agent GitHub issue #153](https://github.com/allegroai/clearml-agent **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](https://github.com/allegroai/clearml/issues/709) +in target local path ([ClearML GitHub issue #709](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/761) -* Add custom artifact serialization for pipelines [ClearML GitHub issue #689](https://github.com/allegroai/clearml/issues/689) -* Add table layout configuration to `Logger.report_table()` through `extra_data` parameter [#796](https://github.com/allegroai/clearml/issues/796) +* Add `Task.get_debug_sample()` to retrieve task's debug samples ([ClearML GitHub issue #761](https://github.com/allegroai/clearml/issues/761)) +* Add custom artifact serialization for pipelines ([ClearML GitHub issue #689](https://github.com/allegroai/clearml/issues/689)) +* Add table layout configuration to `Logger.report_table()` through `extra_data` parameter ([ClearML GitHub issue #796](https://github.com/allegroai/clearml/issues/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 @@ -69,18 +69,18 @@ in target local path [ClearML GitHub issue #709](https://github.com/allegroai/cl * 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](https://github.com/allegroai/clearml/pull/948) -* Improve `hyper_parameter` example [ClearML PR #927](https://github.com/allegroai/clearml/pull/927) -* Correct `Task.connect()` docstring [ClearML Docs issue #473](https://github.com/allegroai/clearml-DOCS/issues/473) -* Improve the `Task.mark_completed()` and `Task.close()` docstrings [ClearML Docs issue #486](https://github.com/allegroai/clearml-docs/issues/486) +* Add `Getting Started` Notebooks ([ClearML PR #948](https://github.com/allegroai/clearml/pull/948)) +* Improve `hyper_parameter` example ([ClearML PR #927](https://github.com/allegroai/clearml/pull/927)) +* Correct `Task.connect()` docstring ([ClearML Docs issue #473](https://github.com/allegroai/clearml-DOCS/issues/473)) +* Improve the `Task.mark_completed()` and `Task.close()` docstrings ([ClearML Docs issue #486](https://github.com/allegroai/clearml-docs/issues/486)) **Bug Fixes** -* Fix logging dependencies that use the subdirectory argument when pip installing from a git repo [ClearML GitHub issue #946](https://github.com/allegroai/clearml/issues/946) -* Fix `Task.import_offline_session()` does not import offline models [ClearML GitHub issue #653](https://github.com/allegroai/clearml/issues/653) -* Fix `clearml-init` incorrectly sets Web and API server ports [Clearml Server GitHub issue #181](https://github.com/allegroai/clearml-server/issues/181) and [ClearML GitHub issue #910](https://github.com/allegroai/clearml/issues/910) -* Fix multiple models trained by the same framework are not all automatically logged [ClearML GitHub issue #767](https://github.com/allegroai/clearml/issues/767) -* Fix parallel coordinates plot displays categorical variables unclearly [ClearML GitHub issue #907](https://github.com/allegroai/clearml/issues/907) +* Fix logging dependencies that use the subdirectory argument when pip installing from a git repo ([ClearML GitHub issue #946](https://github.com/allegroai/clearml/issues/946)) +* Fix `Task.import_offline_session()` does not import offline models ([ClearML GitHub issue #653](https://github.com/allegroai/clearml/issues/653)) +* Fix `clearml-init` incorrectly sets Web and API server ports ([ClearML Server GitHub issue #181](https://github.com/allegroai/clearml-server/issues/181) and [ClearML GitHub issue #910](https://github.com/allegroai/clearml/issues/910)) +* Fix multiple models trained by the same framework are not all automatically logged ([ClearML GitHub issue #767](https://github.com/allegroai/clearml/issues/767)) +* Fix parallel coordinates plot displays categorical variables unclearly ([ClearML GitHub issue #907](https://github.com/allegroai/clearml/issues/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 @@ -100,13 +100,13 @@ in target local path [ClearML GitHub issue #709](https://github.com/allegroai/cl **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](https://github.com/allegroai/clearml/issues/810) + * Add Lineage tab to UI model page, which displays experiment that created model and lists experiments that use the model ([ClearML GitHub issue #810](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/724): +* Add project hierarchy view for ClearML resources (pipelines, datasets, hyper-datasets, reports) ([ClearML GitHub issue #724](https://github.com/allegroai/clearml/issues/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](https://github.com/allegroai/clearml/issues/795) -* Update ElasticSearch image to 7.17.7 [ClearML Server GitHub issue #183](https://github.com/allegroai/clearml-server/issues/183) +* Add archived experiment inclusion in UI experiment comparison ([ClearML GitHub issue #795](https://github.com/allegroai/clearml/issues/795)) +* Update ElasticSearch image to 7.17.7 ([ClearML Server GitHub issue #183](https://github.com/allegroai/clearml-server/issues/183)) * Add reported plot support for multiple color formats * Add running tasks to UI project overview metric snapshot * Improve UI Reports: @@ -116,7 +116,7 @@ in target local path [ClearML GitHub issue #709](https://github.com/allegroai/cl * 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](https://github.com/allegroai/clearml-server/issues/180) +* Fix UI scalar plot smoothing is biased towards initial value ([ClearML Server GitHub issue #180](https://github.com/allegroai/clearml-server/issues/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 diff --git a/docs/release_notes/ver_1_11.md b/docs/release_notes/ver_1_11.md index 795ad1d2..25dfcd94 100644 --- a/docs/release_notes/ver_1_11.md +++ b/docs/release_notes/ver_1_11.md @@ -5,9 +5,9 @@ title: Version 1.11 ### ClearML SDK 1.11.1 **New Features and Improvements** -* Support `lightning>=2.0` [ClearML GitHub issue #1032](https://github.com/allegroai/clearml/issues/1032) -* Add `clearml-init` support for standard HTTP and HTTPS ports in webapp in conjunction with non-default api/files server ports -[ClearML Server GitHub issue #198](https://github.com/allegroai/clearml-server/issues/198) +* Support `lightning>=2.0` ([ClearML GitHub issue #1032](https://github.com/allegroai/clearml/issues/1032)) +* Add `clearml-init` support for standard HTTP and HTTPS ports in webapp in conjunction with non-default api/files server ports + ([ClearML Server GitHub issue #198](https://github.com/allegroai/clearml-server/issues/198)) * Improve docstrings **Bug Fixes** @@ -20,8 +20,8 @@ title: Version 1.11 ### ClearML SDK 1.11.0 **New Features and Improvements** -* Add offline mode for ClearML Datasets [ClearML GitHub issue #854](https://github.com/allegroai/clearml/issues/854) -* Improve performance of `Dataset.add_external_files()` [ClearML GitHub PR #962](https://github.com/allegroai/clearml/pull/962) +* Add offline mode for ClearML Datasets ([ClearML GitHub issue #854](https://github.com/allegroai/clearml/issues/854)) +* Improve performance of `Dataset.add_external_files()` ([ClearML GitHub PR #962](https://github.com/allegroai/clearml/pull/962)) * Add `Task.launch_multi_node()` for distributed experiment execution * Add `Task.get_all_reported_scalars()` to fetch all available scalar data * Add `Task.remove_input_models()` to disassociate input models from a task @@ -30,10 +30,10 @@ title: Version 1.11 * Add support for automatic Dataset content preview for JSON files **Bug Fixes** -* Fix multiple local parallel experiments conflicting on storage access validation [ClearML GitHub issue #897](https://github.com/allegroai/clearml/issues/897) -* Fix code running with `joblib` hangs [ClearML GitHub issue #1009](https://github.com/allegroai/clearml/issues/1009) -* Fix comment for storage scheme `gs://` [ClearML GitHub issue #986](https://github.com/allegroai/clearml/issues/986) -* Fix typo "Categories per column" [ClearML GitHub PR #1021](https://github.com/allegroai/clearml/pull/1021) +* Fix multiple local parallel experiments conflicting on storage access validation ([ClearML GitHub issue #897](https://github.com/allegroai/clearml/issues/897)) +* Fix code running with `joblib` hangs ([ClearML GitHub issue #1009](https://github.com/allegroai/clearml/issues/1009)) +* Fix comment for storage scheme `gs://` ([ClearML GitHub issue #986](https://github.com/allegroai/clearml/issues/986)) +* Fix typo "Categories per column" ([ClearML GitHub PR #1021](https://github.com/allegroai/clearml/pull/1021)) * Fix downloading artifacts from GCP when the download URI includes unsafe characters * Fix pipeline step cache is not cleared when the only change to the step is that the docker image changed * Fix `Task.report_text()` sometimes reporting to an incorrect task when multiple tasks run simultaneously @@ -47,7 +47,7 @@ title: Version 1.11 **New Features and Improvements** * New model comparison UI: compare model configuration, metrics, and plots * Add Preview tab to UI pipeline for viewing debug samples and plots attached to a pipeline -* Add dynamic side panel width in UI experiment artifacts and configuration [ClearML Server GitHub issue #160](https://github.com/allegroai/clearml-server/issues/160) +* Add dynamic side panel width in UI experiment artifacts and configuration ([ClearML Server GitHub issue #160](https://github.com/allegroai/clearml-server/issues/160)) * Add support for embedding following UI resources in reports: * Single-value-scalar table plots * Application dashboard graphs @@ -61,11 +61,11 @@ title: Version 1.11 **Bug Fixes** -* Fix UI experiment plot history navigation not working correctly [ClearML GitHub issue #955](https://github.com/allegroai/clearml/issues/955) -* Support browser native context menu (via right click) in UI experiment hyperparameters [ClearML GitHub issue #990](https://github.com/allegroai/clearml/issues/990) -* Fix `series` argument not in UI experiment debug samples when using `logger.report_media` [ClearML GitHub issue #685](https://github.com/allegroai/clearml/issues/685) -* Fix smoothing bar not displayed in UI experiment comparison scalars in full screen mode [ClearML GitHub issue #996](https://github.com/allegroai/clearml/issues/996) -* Fix uploading image in UI report raises error [ClearML GitHub issue #1020](https://github.com/allegroai/clearml/issues/1020) +* Fix UI experiment plot history navigation not working correctly ([ClearML GitHub issue #955](https://github.com/allegroai/clearml/issues/955)) +* Support browser native context menu (via right click) in UI experiment hyperparameters ([ClearML GitHub issue #990](https://github.com/allegroai/clearml/issues/990)) +* Fix `series` argument not in UI experiment debug samples when using `logger.report_media` ([ClearML GitHub issue #685](https://github.com/allegroai/clearml/issues/685)) +* Fix smoothing bar not displayed in UI experiment comparison scalars in full screen mode ([ClearML GitHub issue #996](https://github.com/allegroai/clearml/issues/996)) +* Fix uploading image in UI report raises error ([ClearML GitHub issue #1020](https://github.com/allegroai/clearml/issues/1020)) * Add mobile device support for UI experiment tab selection * Fix deleting models doesn't remove their weight files from fileserver * Fix "Load More" button does not work in UI experiment comparison "Add Experiment" modal diff --git a/docs/release_notes/ver_1_12.md b/docs/release_notes/ver_1_12.md index b68fca49..44c5eaee 100644 --- a/docs/release_notes/ver_1_12.md +++ b/docs/release_notes/ver_1_12.md @@ -9,7 +9,7 @@ title: Version 1.12 the Pipeline DAG at runtime (as opposed to adhering to the existing structure stored on the task when running locally) **Bug Fixes** -* Fix using `OutputModel` reporting and other methods fail if `OutputModel.update_weights()` is not called before that [ClearML GitHub issue #1078](https://github.com/allegroai/clearml/issues/1078) +* Fix using `OutputModel` reporting and other methods fail if `OutputModel.update_weights()` is not called before that ([ClearML GitHub issue #1078](https://github.com/allegroai/clearml/issues/1078)) * Fix hash for Pandas objects artifacts * Fix Hydra/OmegaConf `--overrides` support * Fix Pipeline metrics not forwarded to pipeline controller at the end of a pipeline step @@ -17,31 +17,31 @@ the Pipeline DAG at runtime (as opposed to adhering to the existing structure st ### ClearML Server 1.12.1 **Bug Fixes** -* Fix UI experiment scalars and plots not updated on auto-refresh [ClearML GitHub issue #1086](https://github.com/allegroai/clearml/issues/1086) +* Fix UI experiment scalars and plots not updated on auto-refresh ([ClearML GitHub issue #1086](https://github.com/allegroai/clearml/issues/1086)) * Fix pipeline parameters not displayed in UI pipeline "New Run" modal * Fix UI pipeline project cards display incorrect pipeline run counts ### ClearML SDK 1.12.1 **New Features and Improvements** -* Raise error if dataset name is empty [ClearML GitHub PR #1083](https://github.com/allegroai/clearml/pull/1083) +* Raise error if dataset name is empty ([ClearML GitHub PR #1083](https://github.com/allegroai/clearml/pull/1083)) * Add support for `spawn` start method for Python `multiprocess`. This should help circumvent issues like [this](https://github.com/python/cpython/issues/84559). **Bug Fixes** -* Fix S3 uploads fail with `LazyEvalWrapper` type error [ClearML GitHub issue #1081](https://github.com/allegroai/clearml/issues/1081) +* Fix S3 uploads fail with `LazyEvalWrapper` type error ([ClearML GitHub issue #1081](https://github.com/allegroai/clearml/issues/1081)) ### ClearML Server 1.12.0 **New Features and Improvements** * Additional UI cloud storage access options: - * Support for AWS S3 temporary access tokens [ClearML GitHub issue #200](https://github.com/allegroai/clearml-server/issues/200) and [ClearML Web GitHub issue #52](https://github.com/allegroai/clearml-web/issues/52) + * Support for AWS S3 temporary access tokens ([ClearML GitHub issue #200](https://github.com/allegroai/clearml-server/issues/200) and [ClearML Web GitHub issue #52](https://github.com/allegroai/clearml-web/issues/52)) * Support credentials for private GCS buckets -* Add multiple smoothing algorithms to UI scalar plots [ClearML GitHub issue #996](https://github.com/allegroai/clearml/issues/996) +* Add multiple smoothing algorithms to UI scalar plots ([ClearML GitHub issue #996](https://github.com/allegroai/clearml/issues/996)) * Running average * Exponential running average * Gaussian -* Add exporting UI object table data in CSV format [ClearML GitHub issue #882](https://github.com/allegroai/clearml/issues/882) -* Increase console log page size [ClearML Web GitHub PR #58](https://github.com/allegroai/clearml-web/pull/58) +* Add exporting UI object table data in CSV format ([ClearML GitHub issue #882](https://github.com/allegroai/clearml/issues/882)) +* Increase console log page size ([ClearML Web GitHub PR #58](https://github.com/allegroai/clearml-web/pull/58)) * Add Python executable to UI experiment execution tab * Improve naming scheme for UI plots download as PNG: files are saved with same name as plot object * Add keyboard arrow-key controls for UI "Add tag" menu @@ -51,9 +51,9 @@ the Pipeline DAG at runtime (as opposed to adhering to the existing structure st * Add iteration specification to plots in task comparison plots page **Bug Fixes** -* Fix handling of the subpaths with nginx templating [ClearML Server GitHub PR #204](https://github.com/allegroai/clearml-server/pull/204) -* Fix fullscreen single-iteration plot displays history slider [ClearML GitHub issue #909](https://github.com/allegroai/clearml/issues/909) -* Fix UI new project modal does not accept Azure URLs for default output destination field [ClearML GitHub issue #1047](https://github.com/allegroai/clearml/issues/1047) +* Fix handling of the subpaths with nginx templating ([ClearML Server GitHub PR #204](https://github.com/allegroai/clearml-server/pull/204)) +* Fix fullscreen single-iteration plot displays history slider ([ClearML GitHub issue #909](https://github.com/allegroai/clearml/issues/909)) +* Fix UI new project modal does not accept Azure URLs for default output destination field ([ClearML GitHub issue #1047](https://github.com/allegroai/clearml/issues/1047)) * Fix missing "Description" column in UI dataset version table * Fix UI scalar plots notation for small and large scale values * Fix UI experiment comparison does not display experiments' last reported iterations @@ -108,16 +108,16 @@ the instructions [here](https://github.com/allegroai/clearml/tree/master/docs/er ::: **New Features and Improvements** -* Add `include_archive` parameter to `Dataset.list_datasets()`: include archived datasets in list [ClearML GitHub issue #1067](https://github.com/allegroai/clearml/issues/1067) +* Add `include_archive` parameter to `Dataset.list_datasets()`: include archived datasets in list ([ClearML GitHub issue #1067](https://github.com/allegroai/clearml/issues/1067)) * Add support to specify the multipart chunk size and threshold using the `aws.boto3.multipart_chunksize` and -`aws.boto3.multipart_threshold` configuration options in the clearml.conf [ClearML GitHub issue #1058](https://github.com/allegroai/clearml/issues/1058) +`aws.boto3.multipart_threshold` configuration options in the clearml.conf ([ClearML GitHub issue #1058](https://github.com/allegroai/clearml/issues/1058)) * Add `PipelineController.get_pipeline()` for retrieving previously run pipelines. **Bug Fixes** -* Fix AWS driver issues: [ClearML GitHub PR #1000](https://github.com/allegroai/clearml/pull/1000) +* Fix AWS driver issues ([ClearML GitHub PR #1000](https://github.com/allegroai/clearml/pull/1000)): * Fix credential authentication failure when attempting to use token * Fix instantiation within VPC without AvailabilityZones -* Fix `continue_last_task=0` is ignored in pipelines run with `retry_on_failure` [ClearML GitHub issue #1054](https://github.com/allegroai/clearml/issues/1054) +* Fix `continue_last_task=0` is ignored in pipelines run with `retry_on_failure` ([ClearML GitHub issue #1054](https://github.com/allegroai/clearml/issues/1054)) * Fix `Task.connect_configuration()` doesn't handle dictionaries with special characters * Fix pipeline steps created with `PipelineDecorator` aren't cached * Fix `Task.get_by_name()` doesn't return the most recent task when multiple tasks have same name diff --git a/docs/release_notes/ver_1_13.md b/docs/release_notes/ver_1_13.md index aad16429..78fd5ea0 100644 --- a/docs/release_notes/ver_1_13.md +++ b/docs/release_notes/ver_1_13.md @@ -12,22 +12,22 @@ title: Version 1.13 **New Features and Improvements** * Improve UI comparison - * Add visual comparison of single value scalars [ClearML Server GitHub issue #202](https://github.com/allegroai/clearml-server/issues/202) - * Scalar value comparison: metrics are presented in a single table [ClearML GitHub issue #760](https://github.com/allegroai/clearml/issues/760) - * Add global experiment legend: Experiment name, tags and color [ClearML GitHub issue #81](https://github.com/allegroai/clearml/issues/81) - * Clickable URLs/object IDs in experiment details comparison [ClearML GitHub issue #1073](https://github.com/allegroai/clearml/issues/1073) + * Add visual comparison of single value scalars ([ClearML Server GitHub issue #202](https://github.com/allegroai/clearml-server/issues/202)) + * Scalar value comparison: metrics are presented in a single table ([ClearML GitHub issue #760](https://github.com/allegroai/clearml/issues/760)) + * Add global experiment legend: Experiment name, tags and color ([ClearML GitHub issue #81](https://github.com/allegroai/clearml/issues/81)) + * Clickable URLs/object IDs in experiment details comparison ([ClearML GitHub issue #1073](https://github.com/allegroai/clearml/issues/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 [ClearML Server GitHub issue #170](https://github.com/allegroai/clearml-server/issues/170) +* Improve UI experiment debug sample iteration fetching speed ([ClearML Server GitHub issue #170](https://github.com/allegroai/clearml-server/issues/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 GitHub issue #1111](https://github.com/allegroai/clearml/issues/1111) -* Fix UI pipeline step duration does not update during runtime [ClearML GitHub issue #1090](https://github.com/allegroai/clearml/issues/1090) -* Fix UI experiment comparison parallel coordinates plot crops the metric and parameter names [ClearML GitHub issue #1111](https://github.com/allegroai/clearml/issues/1111) -* Fix hidden experiments appear in UI All Experiments search results [ClearML GitHub issue #1139](https://github.com/allegroai/clearml/issues/1139) +* Fix UI single-value scalars table does not display all single-value scalars ([ClearML GitHub issue #1111](https://github.com/allegroai/clearml/issues/1111)) +* Fix UI pipeline step duration does not update during runtime ([ClearML GitHub issue #1090](https://github.com/allegroai/clearml/issues/1090)) +* Fix UI experiment comparison parallel coordinates plot crops the metric and parameter names ([ClearML GitHub issue #1111](https://github.com/allegroai/clearml/issues/1111)) +* Fix hidden experiments appear in UI All Experiments search results ([ClearML GitHub issue #1139](https://github.com/allegroai/clearml/issues/1139)) * 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 @@ -61,8 +61,8 @@ title: Version 1.13 **New Features and Improvements** -* Support parallel dataset verification [ClearML GitHub issue #1130](https://github.com/allegroai/clearml/issues/1130) -* Support `lightgbm` model loading from a string [ClearML GitHub issue #1135](https://github.com/allegroai/clearml/issues/1135) +* Support parallel dataset verification ([ClearML GitHub issue #1130](https://github.com/allegroai/clearml/issues/1130)) +* Support `lightgbm` model loading from a string ([ClearML GitHub issue #1135](https://github.com/allegroai/clearml/issues/1135)) * Add support for Hydra command-line syntax for modifying `omegaconf` * Add support for setting `output_uri` in pipeline decorators and functions * Add more visibility when overriding `jsonargparse` arguments @@ -71,17 +71,17 @@ title: Version 1.13 * Support ignoring `default_output_uri` on remote runs when `Task.init(output_uri=False)` was specified and the backend task data has no `output_uri` specified * Add configuration files logging [example](https://github.com/allegroai/clearml/blob/e6f1cc8a5c65f7007cf6452745d09795e776a548/examples/reporting/config_files.py) * Support raising `LoginError` when initializing -* Add HuggingFace Transformers example [ClearML GitHub PR #1146](https://github.com/allegroai/clearml/pull/1146) +* Add HuggingFace Transformers example ([ClearML GitHub PR #1146](https://github.com/allegroai/clearml/pull/1146)) * Improve docstrings for tag filters -* Add a security policy file to the repository [ClearML GitHub issue #1148](https://github.com/allegroai/clearml/issues/1148) +* Add a security policy file to the repository ([ClearML GitHub issue #1148](https://github.com/allegroai/clearml/issues/1148)) **Bug Fixes** -* Fix Google Storage subdir path in bucket URL breaks validation [ClearML GitHub PR #1117](https://github.com/allegroai/clearml/pull/1117) -* Fix jsonschema `DeprecationWarning` in newer versions [ClearML GitHub PR #1128](https://github.com/allegroai/clearml/pull/1128) -* Fix `task.set_script(diff="")` does not clear the uncommitted changes [ClearML GitHub issue #1106](https://github.com/allegroai/clearml/issues/1106) -* Fix parallel dataset verification fails on older Python versions [ClearML GitHub issue #1144](https://github.com/allegroai/clearml/issues/1144) -* Fix `attrs.__version__` deprecation warning [ClearML GitHub issue #1145](https://github.com/allegroai/clearml/issues/1145) +* Fix Google Storage subdir path in bucket URL breaks validation ([ClearML GitHub PR #1117](https://github.com/allegroai/clearml/pull/1117)) +* Fix jsonschema `DeprecationWarning` in newer versions ([ClearML GitHub PR #1128](https://github.com/allegroai/clearml/pull/1128)) +* Fix `task.set_script(diff="")` does not clear the uncommitted changes ([ClearML GitHub issue #1106](https://github.com/allegroai/clearml/issues/1106)) +* Fix parallel dataset verification fails on older Python versions ([ClearML GitHub issue #1144](https://github.com/allegroai/clearml/issues/1144)) +* Fix `attrs.__version__` deprecation warning ([ClearML GitHub issue #1145](https://github.com/allegroai/clearml/issues/1145)) * Fix `Task.get_parameters_as_dict(cast=True)` raises a YAML parser error * Fix potential threading issues when setting `self.lock` to `None` * Fix pipeline version is not displayed in the table view and version list @@ -96,21 +96,21 @@ title: Version 1.13 ### ClearML SDK 1.13.1 **Bug Fixes** -* Fix Hydra overrides integration [ClearML GitHub issue #1120](https://github.com/allegroai/clearml/issues/1120) +* Fix Hydra overrides integration ([ClearML GitHub issue #1120](https://github.com/allegroai/clearml/issues/1120)) * Fix GPU memory used reports 0 when memory can not be queried per process (edge case) ### ClearML SDK 1.13.0 **New Features** -* Add support for recursive list, dict, and tuple ref parsing for `PipelineController.add step()` parameter overrides [ClearML GitHub issue #1089](https://github.com/allegroai/clearml/issues/1089) +* Add support for recursive list, dict, and tuple ref parsing for `PipelineController.add step()` parameter overrides ([ClearML GitHub issue #1089](https://github.com/allegroai/clearml/issues/1089)) * Update PyNVML to the latest NVIDIA version for better GPU monitoring * Add `force_single_script_file` argument to `Task.create()` to avoid git repository auto detection * Use `os.register_at_fork` instead of monkey patching fork for `python>3.6` * Add support to programmatically archive and unarchive models from the model registry using the `Model.archive()` and -`Model.unarchive()` methods [ClearML GitHub issue #1096](https://github.com/allegroai/clearml/issues/1096) +`Model.unarchive()` methods ([ClearML GitHub issue #1096](https://github.com/allegroai/clearml/issues/1096)) **Bug Fixes** -* Fix model reporting in TensorFlow 2.13 does not work properly [ClearML GitHub issue #1112](https://github.com/allegroai/clearml/issues/1112) +* Fix model reporting in TensorFlow 2.13 does not work properly ([ClearML GitHub issue #1112](https://github.com/allegroai/clearml/issues/1112)) * Fix GPU memory used reports 0 when memory can not be queried per process * Fix FastAI binding not reporting scalars if TensorBoard is installed * Fix JSON serialization error does not raise exception diff --git a/docs/release_notes/ver_1_14.md b/docs/release_notes/ver_1_14.md index f2dfdaed..2d27fa79 100644 --- a/docs/release_notes/ver_1_14.md +++ b/docs/release_notes/ver_1_14.md @@ -5,7 +5,7 @@ title: Version 1.14 ### ClearML SDK 1.14.4 **Bug Fixes** -* Fix AWS S3 configuration `secure` property not forwarded in `StorageHelper` [ClearML GitHub PR #1205](https://github.com/allegroai/clearml/pull/1205) +* Fix AWS S3 configuration `secure` property not forwarded in `StorageHelper` ([ClearML GitHub PR #1205](https://github.com/allegroai/clearml/pull/1205) * Fix `NVIDIA_VISIBLE_DEVICES=all` env var value will result in no GPU metrics being reported * Fix setting `output_uri` when an AWS S3 config section with `secure=false` exists raises an error * Fix `CacheManager` attempts to clear cache when file limit has not been reached resulting in slow unnecessary checks @@ -17,7 +17,7 @@ title: Version 1.14 * Change default cookie `SameSite` setting to `Lax` **Bug Fixes** -* Fix clicking on UI Metric Snapshot datapoint does not navigate to experiment [ClearML Server GitHub issue #228](https://github.com/allegroai/clearml-server/issues/228) +* Fix clicking on UI Metric Snapshot datapoint does not navigate to experiment ([ClearML Server GitHub issue #228](https://github.com/allegroai/clearml-server/issues/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 @@ -28,7 +28,7 @@ title: Version 1.14 **New Features and Bug Fixes** * Add hash check for pickle files (resolves [CVE-2024-24590](https://github.com/advisories/GHSA-cpcw-9h9m-wqw9)) -* Fix `clearml-task` relative paths calculation when `--cwd`, `--folder`, and `--script` are provided [ClearML GitHub issue #1160](https://github.com/allegroai/clearml/issues/1160) +* Fix `clearml-task` relative paths calculation when `--cwd`, `--folder`, and `--script` are provided ([ClearML GitHub issue #1160](https://github.com/allegroai/clearml/issues/1160)) * Fix regression causing an error when `secure` is provided in AWS S3 bucket settings ### ClearML SDK 1.14.2 @@ -41,10 +41,10 @@ title: Version 1.14 disable overriding values when running remotely * Add support for setting a custom certificate path using the `CLEARML_API_HOST_VERIFY_CERT` environment variable (instead of just allowing the user to disable verification) -* Add dataset reporting example [ClearML GitHub PR #1180](https://github.com/allegroai/clearml/pull/1180) +* Add dataset reporting example ([ClearML GitHub PR #1180](https://github.com/allegroai/clearml/pull/1180)) **Bug Fixes** -* Fix missing component callbacks on multiple step calls [ClearML GitHub PR #1195](https://github.com/allegroai/clearml/pull/1195) +* Fix missing component callbacks on multiple step calls ([ClearML GitHub PR #1195](https://github.com/allegroai/clearml/pull/1195)) * Fix unsafe usage of `tempfile.mktemp` * Fix potential path traversal on file download ([CVE-2024-24591](https://github.com/advisories/GHSA-m95h-p4gg-wfw3)) * Fix Python 3.12 support by not using `distutils` @@ -60,7 +60,7 @@ title: Version 1.14 ### ClearML SDK 1.14.0 **New Features and Improvements** -* Add support for decorated pipeline steps [ClearML GitHub issue #1154](https://github.com/allegroai/clearml/issues/1154) +* Add support for decorated pipeline steps ([ClearML GitHub issue #1154](https://github.com/allegroai/clearml/issues/1154)) * Improve `torch.distributed` behavior and auto-detect Huggingface accelerate distributed execution * Improve `jsonargparse` integration: `allow_config_file_override_from_ui` argument added for enabling/disabling overriding configuration file entries @@ -74,10 +74,10 @@ and can be imported globally instead * Add tabular data multi-stage pipeline process example **Bug Fixes** -* Fix `langchain` integration [ClearML GitHub issues #1124](https://github.com/allegroai/clearml/issues/1124) and [ClearML GitHub issue #1126](https://github.com/allegroai/clearml/issues/1126) -* Fix using `target_project` with `TaskScheduler.add_task()` corrupts project if used with pipelines [ClearML GitHub issue #1137](https://github.com/allegroai/clearml/issues/1137) -* Fix `PipelineController.add_function_step()` fails when adding custom decorated step [ClearML GitHub issue #1154](https://github.com/allegroai/clearml/issues/1154) -* Fix `jsonargparse` binding does not capture parameters before `Task.init()` is called [ClearML GitHub issue #1164](https://github.com/allegroai/clearml/issues/1164) +* Fix `langchain` integration ([ClearML GitHub issues #1124](https://github.com/allegroai/clearml/issues/1124) and [ClearML GitHub issue #1126](https://github.com/allegroai/clearml/issues/1126)) +* Fix using `target_project` with `TaskScheduler.add_task()` corrupts project if used with pipelines ([ClearML GitHub issue #1137](https://github.com/allegroai/clearml/issues/1137)) +* Fix `PipelineController.add_function_step()` fails when adding custom decorated step ([ClearML GitHub issue #1154](https://github.com/allegroai/clearml/issues/1154)) +* Fix `jsonargparse` binding does not capture parameters before `Task.init()` is called ([ClearML GitHub issue #1164](https://github.com/allegroai/clearml/issues/1164)) * Fix invalid `jsonargparse` arguments should be deleted * Fix handling of appended parameters to Hydra defaults list * Fix `Task.set_repo()` and `Task.set_packages()` do not wait for automatic asynchronous repository detection @@ -90,7 +90,7 @@ processes except for the `BackgroundMonitor` **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 GitHub issue #793](https://github.com/allegroai/clearml/issues/793) +* Add UI experiment display of original python requirements along with actual packages used ([ClearML GitHub issue #793](https://github.com/allegroai/clearml/issues/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 diff --git a/docs/release_notes/ver_1_15.md b/docs/release_notes/ver_1_15.md index 6423786d..2a9d75ce 100644 --- a/docs/release_notes/ver_1_15.md +++ b/docs/release_notes/ver_1_15.md @@ -5,31 +5,31 @@ title: Version 1.15 ### ClearML Server 1.15.1 **Bug Fix** -* Fix restarting ClearML Server deletes app credentials [ClearML Server GitHub issue #240](https://github.com/allegroai/clearml-server/issues/240) and ClearML GitHub issues [#1247](https://github.com/allegroai/clearml/issues/1257) & [#1262](https://github.com/allegroai/clearml/issues/1262) +* Fix restarting ClearML Server deletes app credentials ([ClearML Server GitHub issue #240](https://github.com/allegroai/clearml-server/issues/240) and ClearML GitHub issues [#1247](https://github.com/allegroai/clearml/issues/1257) & [#1262](https://github.com/allegroai/clearml/issues/1262)) ### ClearML SDK 1.15.1 **Bug Fixes** -* Fix autoscaler should recheck that the worker is still idle before shutting it down [ClearML GitHub issue #1202](https://github.com/allegroai/clearml/issues/1202) +* Fix autoscaler should recheck that the worker is still idle before shutting it down ([ClearML GitHub issue #1202](https://github.com/allegroai/clearml/issues/1202)) * Fix resource monitor fails to get GPU stats in some edge cases ### ClearML SDK 1.15.0 **New Features** -* Add draft option to pipeline steps [ClearML GitHub PR #1226](https://github.com/allegroai/clearml/pull/1226) -* Add support for custom working directory for pipelines [ClearML GitHub issue #1194](https://github.com/allegroai/clearml/issues/1194) +* Add draft option to pipeline steps ([ClearML GitHub PR #1226](https://github.com/allegroai/clearml/pull/1226)) +* Add support for custom working directory for pipelines ([ClearML GitHub issue #1194](https://github.com/allegroai/clearml/issues/1194)) * Add `Task.get_requirements()` method that returns the task's requirements * Allow controlling the number of threads used by `StorageManager.download_folder()` using the `max_workers` argument * Update examples dependencies * Improve auto populate in `Task.init()` **Bug Fixes** -* Fix UTF-8 script code encoding issue [ClearML GitHub issue #1207](https://github.com/allegroai/clearml/issues/1207) -* Fix Colab docs [ClearML GitHub issue #1204](https://github.com/allegroai/clearml/issues/1204) -* Fix metrics reporting with `OutputModel` while in offline mode results in an error [ClearML GitHub issue #1172](https://github.com/allegroai/clearml/issues/1172) -* Fix task running in Google Colab doesn't properly get the notebook diff [ClearML GitHub issue #1204](https://github.com/allegroai/clearml/issues/1204) -* Fix hydra binds break in offline mode [ClearML GitHub issue #1215](https://github.com/allegroai/clearml/issues/1215) -* Fix HPO crashes when optimizing for single value scalars [ClearML GitHub issue #1221](https://github.com/allegroai/clearml/issues/1221) +* Fix UTF-8 script code encoding issue ([ClearML GitHub issue #1207](https://github.com/allegroai/clearml/issues/1207)) +* Fix Colab docs ([ClearML GitHub issue #1204](https://github.com/allegroai/clearml/issues/1204)) +* Fix metrics reporting with `OutputModel` while in offline mode results in an error ([ClearML GitHub issue #1172](https://github.com/allegroai/clearml/issues/1172)) +* Fix task running in Google Colab doesn't properly get the notebook diff ([ClearML GitHub issue #1204](https://github.com/allegroai/clearml/issues/1204)) +* Fix hydra binds break in offline mode ([ClearML GitHub issue #1215](https://github.com/allegroai/clearml/issues/1215)) +* Fix HPO crashes when optimizing for single value scalars ([ClearML GitHub issue #1221](https://github.com/allegroai/clearml/issues/1221)) * Fix GPU info such as `gpu_memory` and `gpu_type` is not being collected in some cases * Fix `clearml-data` CLI tool moves non-dataset tasks to a `.dataset` project when the respective task is not a dataset * Fix pandas `DataFrame` artifacts with hierarchical indices get mangled by the CSV round-trip @@ -44,16 +44,16 @@ title: Version 1.15 **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 GitHub issue #984](https://github.com/allegroai/clearml/issues/984) + * Add scatter plot mode to UI experiment hyperparameter comparison ([ClearML GitHub issue #984](https://github.com/allegroai/clearml/issues/984)) * Add model lineage to UI model comparison -* Update nginx version to Fix 1-Byte Memory Overwrite RCE vulnerability [ClearML Server GitHub issue #230](https://github.com/allegroai/clearml-server/issues/230) +* Update nginx version to Fix 1-Byte Memory Overwrite RCE vulnerability ([ClearML Server GitHub issue #230](https://github.com/allegroai/clearml-server/issues/230)) **Bug Fixes** -* Fix Heap Buffer Overflow vulnerability (CVE-2023-38545) [ClearML Server GitHub issue #234](https://github.com/allegroai/clearml-server/issues/234) +* Fix Heap Buffer Overflow vulnerability (CVE-2023-38545) ([ClearML Server GitHub issue #234](https://github.com/allegroai/clearml-server/issues/234)) * Fix insufficient session expiration vulnerability (CWE-613) * Fix XSS vulnerability (CWE-79) in UI markdown * Fix UI reports vulnerable to XSS attack -* Fix UI generating undefined credentials for Jupyter Notebook [ClearML Web GitHub issue #67](https://github.com/allegroai/clearml-web/issues/67) +* Fix UI generating undefined credentials for Jupyter Notebook ([ClearML Web GitHub issue #67](https://github.com/allegroai/clearml-web/issues/67)) * Fix "No tags" filter raises an error * Fix slow loading speed for UI experiment comparison scalars * Fix some UI experiment sometimes missing plots diff --git a/docs/release_notes/ver_1_16.md b/docs/release_notes/ver_1_16.md index 333b596e..76d449fe 100644 --- a/docs/release_notes/ver_1_16.md +++ b/docs/release_notes/ver_1_16.md @@ -20,9 +20,9 @@ and `sdk.development.worker.max_wait_for_first_iteration_to_start_sec` configura * Add Python 3.12 support **Bug Fixes** -* Fix pytorch-lightning patches [ClearML GitHub issue #1249](https://github.com/allegroai/clearml/issues/1249) -* Fix parameter overrides are converted to string when using HPO [ClearML GitHub issue #975](https://github.com/allegroai/clearml/issues/975) -* Fix FastAI performance [ClearML GitHub issue #1234](https://github.com/allegroai/clearml/issues/1234) +* Fix pytorch-lightning patches ([ClearML GitHub issue #1249](https://github.com/allegroai/clearml/issues/1249)) +* Fix parameter overrides are converted to string when using HPO ([ClearML GitHub issue #975](https://github.com/allegroai/clearml/issues/975)) +* Fix FastAI performance ([ClearML GitHub issue #1234](https://github.com/allegroai/clearml/issues/1234)) * Fix MIG GPU support * Fix AMD GPU metrics collection * Fix Jupyter password might not be used in some protected JupyterLab instances diff --git a/docs/release_notes/ver_1_2.md b/docs/release_notes/ver_1_2.md index a194334b..671d7605 100644 --- a/docs/release_notes/ver_1_2.md +++ b/docs/release_notes/ver_1_2.md @@ -8,7 +8,7 @@ title: Version 1.2 * Improve GPU Performance, 50%-300% improvement over vanilla Triton * Improve performance on CPU, optimize uvloop + multi-processing * Add Huggingface Transformer example -* Add binary input support [ClearML Serving PR #37](https://github.com/allegroai/clearml-serving/pull/37) +* Add binary input support ([ClearML Serving PR #37](https://github.com/allegroai/clearml-serving/pull/37) ) **Bug Fix** * stdout/stderr in inference service not logging to dedicated Task @@ -34,9 +34,9 @@ title: Version 1.2 **New Features and Improvements** -- Update S3 bucket verify option for minio [ClearML Agent GitHub PR #83](https://github.com/allegroai/clearml-agent/pull/83) -- Add environment variable for request method [ClearML Agent GitHub PR #91](https://github.com/allegroai/clearml-agent/pull/91) -- Add additional k8s-glue dockerfiles [ClearML Agent GitHub PR #94](https://github.com/allegroai/clearml-agent/pull/94) +- Update S3 bucket verify option for minio ([ClearML Agent GitHub PR #83](https://github.com/allegroai/clearml-agent/pull/83)) +- Add environment variable for request method ([ClearML Agent GitHub PR #91](https://github.com/allegroai/clearml-agent/pull/91)) +- Add additional k8s-glue dockerfiles ([ClearML Agent GitHub PR #94](https://github.com/allegroai/clearml-agent/pull/94) ) - Update default docker image to `nvidia/cuda:10.2-cudnn7-runtime-ubuntu18.04` - Add support for custom docker image resolving using the `agent.default_docker.match_rules` configuration setting (see [here](https://github.com/allegroai/clearml-agent/blob/8712c5e636d9a02e939a9759348d29521a3939a9/docs/clearml.conf#L169)) - Add `agent.force_git_root_python_path` configuration setting to force adding the git repository root folder to the `PYTHONPATH` (if set working directory is not added to the `PYHTONPATH`) @@ -50,10 +50,10 @@ title: Version 1.2 **Bug Fixes** -- Fix virtualenv python interpreter used [ClearML Agent GitHub PR #98](https://github.com/allegroai/clearml-agent/pull/98) -- Fix typing package incorrectly required for Python>3.5 [ClearML Agent GitHub PR #103](https://github.com/allegroai/clearml-agent/pull/103) -- Fix symbolic links not copied from cached VCS into working copy (windows platform will result with default copy content instead of original symbolic link) [ClearML Agent GitHub PR #89](https://github.com/allegroai/clearml-agent/pull/89) -- Fix agent fails to check out code from main branch when branch/commit is not explicitly specified [ClearML GitHub issue #551](https://github.com/allegroai/clearml/issues/551) +- Fix virtualenv python interpreter used ([ClearML Agent GitHub PR #98](https://github.com/allegroai/clearml-agent/pull/98)) +- Fix typing package incorrectly required for Python>3.5 ([ClearML Agent GitHub PR #103](https://github.com/allegroai/clearml-agent/pull/103)) +- Fix symbolic links not copied from cached VCS into working copy (windows platform will result with default copy content instead of original symbolic link) ([ClearML Agent GitHub PR #89](https://github.com/allegroai/clearml-agent/pull/89)) +- Fix agent fails to check out code from main branch when branch/commit is not explicitly specified ([ClearML GitHub issue #551](https://github.com/allegroai/clearml/issues/551)) - Fix `git+git://` requirements - Fix `default_python` calculation (and verbosity) - Fix using deprecated `abc` support (Python 3.10 compatibility) @@ -73,18 +73,18 @@ title: Version 1.2 **Bug Fixes** -- Fix HTTP download fails constructing URL [ClearML GitHub issue #593](https://github.com/allegroai/clearml/issues/593) +- Fix HTTP download fails constructing URL ([ClearML GitHub issue #593](https://github.com/allegroai/clearml/issues/593)) ### ClearML SDK 1.2.0 **Features** -- Add fastai v2 support [ClearML GitHub PR #571](https://github.com/allegroai/clearml/pull/571) -- Add catboost support [ClearML GitHub PR #542](https://github.com/allegroai/clearml/pull/542) -- Add Python Fire support [ClearML GitHub PR #550](https://github.com/allegroai/clearml/pull/550) -- Add new Azure Storage driver support [ClearML GitHub PR #548](https://github.com/allegroai/clearml/pull/548) -- Add requirements file support in Task.add_requirements [ClearML GitHub PR #575](https://github.com/allegroai/clearml/pull/575) -- Allow overriding `auto_delete_file` in `Task.update_output_model()` [ClearML GitHub issue #554](https://github.com/allegroai/clearml/issues/554) +- Add fastai v2 support ([ClearML GitHub PR #571](https://github.com/allegroai/clearml/pull/571)) +- Add catboost support ([ClearML GitHub PR #542](https://github.com/allegroai/clearml/pull/542)) +- Add Python Fire support ([ClearML GitHub PR #550](https://github.com/allegroai/clearml/pull/550)) +- Add new Azure Storage driver support ([ClearML GitHub PR #548](https://github.com/allegroai/clearml/pull/548)) +- Add requirements file support in `Task.add_requirements `([ClearML GitHub PR #575](https://github.com/allegroai/clearml/pull/575)) +- Allow overriding `auto_delete_file` in `Task.update_output_model()` ([ClearML GitHub issue #554](https://github.com/allegroai/clearml/issues/554)) - Support `artifact_object` empty string - Add `skip_zero_size_check` to `StorageManager.download_folder()` - Add support for extra HTTP retry codes (see [here](https://github.com/allegroai/clearml/blob/2c916181b90c784fe0bd267cd67ea915e53e36e4/clearml/backend_api/config/default/api.conf#L29) or use `CLEARML_API_EXTRA_RETRY_CODES`) @@ -93,18 +93,18 @@ title: Version 1.2 - Add autoscaler CPU-only support - Add AWS autoscaler IAM instance profile support - Update examples - - Edit HTML reporting examples [ClearML GitHub PR #546](https://github.com/allegroai/clearml/pull/546) - - Add model reporting examples [ClearML GitHub PR #553](https://github.com/allegroai/clearml/pull/553) + - Edit HTML reporting examples ([ClearML GitHub PR #546](https://github.com/allegroai/clearml/pull/546)) + - Add model reporting examples ([ClearML GitHub PR #553](https://github.com/allegroai/clearml/pull/553)) **Bug Fixes** -- Fix `nargs="?"` without type does not properly cast the default value [ClearML GitHub issue #531](https://github.com/allegroai/clearml/issues/531) -- Fix using invalid configurations [ClearML GitHub issue #544](https://github.com/allegroai/clearml/issues/544) -- Fix extra_layout not passed to report_matrix [ClearML GitHub issue #559](https://github.com/allegroai/clearml/issues/559) -- Fix group arguments in click [ClearML GitHub PR #561](https://github.com/allegroai/clearml/pull/561) -- Fix no warning when failing to patch argparse [ClearML GitHub PR #576](https://github.com/allegroai/clearml/pull/576) -- Fix crash in `Dataset.upload()` when there is nothing to upload [ClearML GitHub PR #579](https://github.com/allegroai/clearml/pull/579) -- Fix requirements, refactor and reformat examples [ClearML GitHub PR #567](https://github.com/allegroai/clearml/pull/567), [#573](https://github.com/allegroai/clearml/pull/573), [#582](https://github.com/allegroai/clearml/pull/582) +- Fix `nargs="?"` without type does not properly cast the default value ([ClearML GitHub issue #531](https://github.com/allegroai/clearml/issues/531)) +- Fix using invalid configurations ([ClearML GitHub issue #544](https://github.com/allegroai/clearml/issues/544)) +- Fix extra_layout not passed to report_matrix ([ClearML GitHub issue #559](https://github.com/allegroai/clearml/issues/559)) +- Fix group arguments in click ([ClearML GitHub PR #561](https://github.com/allegroai/clearml/pull/561)) +- Fix no warning when failing to patch argparse ([ClearML GitHub PR #576](https://github.com/allegroai/clearml/pull/576)) +- Fix crash in `Dataset.upload()` when there is nothing to upload ([ClearML GitHub PR #579](https://github.com/allegroai/clearml/pull/579)) +- Fix requirements, refactor and reformat examples ([ClearML GitHub PRs #567](https://github.com/allegroai/clearml/pull/567), [#573](https://github.com/allegroai/clearml/pull/573), [#582](https://github.com/allegroai/clearml/pull/582)) - Auto-scaler - Change confusing log message - Fix AWS tags support @@ -119,14 +119,14 @@ title: Version 1.2 - Fix `clearml-init` changing web host after pasting full credentials - Fix fileserver upload does not support path in URL - Fix crash on semaphore acquire error -- Fix docs and docstrings [ClearML GitHub PR #558](https://github.com/allegroai/clearml/pull/558), [#560](https://github.com/allegroai/clearml/pull/560) +- Fix docs and docstrings ([ClearML GitHub PRs #558](https://github.com/allegroai/clearml/pull/558), [#560](https://github.com/allegroai/clearml/pull/560)) ### ClearML Server 1.2.0 **New Features and Improvements** * Add functionality to "Abort all children" UI action for controller and optimizer tasks -* Add parameter search to task configuration UI section [ClearML GitHub issue #467](https://github.com/allegroai/clearml/issues/467) +* Add parameter search to task configuration UI section ([ClearML GitHub issue #467](https://github.com/allegroai/clearml/issues/467)) * Add tag exclusion filters in UI experiment and model tables * Add "Clear Filters" functionality button to UI table filters * Improve full screen scalar graph to display all data points @@ -149,12 +149,12 @@ title: Version 1.2 **Bug Fixes** -* Fix UI debug sample viewer ignoring metric filter on auto-refresh [ClearML GitHub issue #512](https://github.com/allegroai/clearml/issues/512) -* Fix "Wall time" x-axis option in UI plots slowing down web app [ClearML GitHub issue #441](https://github.com/allegroai/clearml/issues/441) -* Fix UI table plot titles don't display their iteration number [ClearML GitHub issue #474](https://github.com/allegroai/clearml/issues/474) -* Fix auto-refresh resets vertical scroll in UI debug samples [ClearML GitHub issue #474](https://github.com/allegroai/clearml/issues/474) -* Fix manually run experiments cannot be edited in UI after being reset [ClearML GitHub issue #449](https://github.com/allegroai/clearml/issues/449) -* Fix UI Workers & Queues and Experiment Table pages display mismatching experiment runtime values [ClearML Server GitHub issue #100](https://github.com/allegroai/clearml-server/issues/100) +* Fix UI debug sample viewer ignoring metric filter on auto-refresh ([ClearML GitHub issue #512](https://github.com/allegroai/clearml/issues/512)) +* Fix "Wall time" x-axis option in UI plots slowing down web app ([ClearML GitHub issue #441](https://github.com/allegroai/clearml/issues/441)) +* Fix UI table plot titles don't display their iteration number ([ClearML GitHub issue #474](https://github.com/allegroai/clearml/issues/474)) +* Fix auto-refresh resets vertical scroll in UI debug samples ([ClearML GitHub issue #474](https://github.com/allegroai/clearml/issues/474)) +* Fix manually run experiments cannot be edited in UI after being reset ([ClearML GitHub issue #449](https://github.com/allegroai/clearml/issues/449)) +* Fix UI Workers & Queues and Experiment Table pages display mismatching experiment runtime values ([ClearML Server GitHub issue #100](https://github.com/allegroai/clearml-server/issues/100)) * Fix UI plots sometimes disappear after task execution completion * Fix UI experiment plots don't display some plots on a http server * Fix failure to add Azure credentials through UI Settings page by new users diff --git a/docs/release_notes/ver_1_3.md b/docs/release_notes/ver_1_3.md index 151e57dc..1dd57991 100644 --- a/docs/release_notes/ver_1_3.md +++ b/docs/release_notes/ver_1_3.md @@ -4,9 +4,9 @@ title: Version 1.3 ### ClearML Serving 1.3.1 **New Features and Bug Fixes** -* Add missing `await` [ClearML Serving GitHub PR #55](https://github.com/allegroai/clearml-serving/pull/55) -* Add traceback for failing to load `preprocess` class [ClearML Serving GitHub issue #57](https://github.com/allegroai/clearml-serving/issues/57) -* Fix Triton `config.pbtxt` for missing values or colliding specifications [ClearML Serving GitHub issue #62](https://github.com/allegroai/clearml-serving/issues/62) +* Add missing `await` ([ClearML Serving GitHub PR #55](https://github.com/allegroai/clearml-serving/pull/55)) +* Add traceback for failing to load `preprocess` class ([ClearML Serving GitHub issue #57](https://github.com/allegroai/clearml-serving/issues/57)) +* Fix Triton `config.pbtxt` for missing values or colliding specifications ([ClearML Serving GitHub issue #62](https://github.com/allegroai/clearml-serving/issues/62)) * Add safer code for pulling from Kafka * Add `str` type to Triton type conversion * Fix ignore auto-detected platform when passing `config.pbtxt` with platform entry @@ -18,17 +18,17 @@ title: Version 1.3 ### ClearML Serving 1.3.0 **New Features and Improvements** * 20% Overall performance increase -* gRPC channel configuration [ClearML Serving GitHub issue #49](https://github.com/allegroai/clearml-serving/issues/49) +* gRPC channel configuration ([ClearML Serving GitHub issue #49](https://github.com/allegroai/clearml-serving/issues/49)) * Huggingface Transformer example **Bug fixes** -* Fix NumPy compatibility [ClearML Serving GitHub issue #47](https://github.com/allegroai/clearml-serving/issues/47) and [#46](https://github.com/allegroai/clearml-serving/issues/46) -* Fix Triton examples [ClearML Serving GitHub issue #48](https://github.com/allegroai/clearml-serving/issues/48) -* Add storage environment variables [ClearML Serving GitHub PR #45](https://github.com/allegroai/clearml-serving/pull/45) +* Fix NumPy compatibility ([ClearML Serving GitHub issue #47](https://github.com/allegroai/clearml-serving/issues/47) and [#46](https://github.com/allegroai/clearml-serving/issues/46)) +* Fix Triton examples ([ClearML Serving GitHub issue #48](https://github.com/allegroai/clearml-serving/issues/48)) +* Add storage environment variables ([ClearML Serving GitHub PR #45](https://github.com/allegroai/clearml-serving/pull/45)) ### ClearML Agent 1.3.0 **New Features and Improvements** -* Support private repos from `requirements.txt` file [ClearML Agent GitHub PR #107](https://github.com/allegroai/clearml-agent/pull/107) +* Support private repos from `requirements.txt` file ([ClearML Agent GitHub PR #107](https://github.com/allegroai/clearml-agent/pull/107)) * Bump PyJWT version due to "*Key confusion through non-blocklisted public key formats*" vulnerability * Add support for additional command line arguments in k8s glue example * Add Python 3.10 support @@ -46,22 +46,22 @@ title: Version 1.3 ### ClearML Server 1.3.1 **Bug Fixes** -* Fix scalar graph smoothing [ClearML Server GitHub issue #127](https://github.com/allegroai/clearml-server/issues/127) +* Fix scalar graph smoothing ([ClearML Server GitHub issue #127](https://github.com/allegroai/clearml-server/issues/127)) ### ClearML SDK 1.3.2 **New Features and Improvements** -* Add support for setting reported values for `NaN` and `Inf` [ClearML GitHub issue #604](https://github.com/allegroai/clearml/issues/604) +* Add support for setting reported values for `NaN` and `Inf` ([ClearML GitHub issue #604](https://github.com/allegroai/clearml/issues/604)) * Add reserved OS environments warning -* Add git credentials to colab example [ClearML GitHub PR #621](https://github.com/allegroai/clearml/pull/621) -* Add jsonargparse support [ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403) +* Add git credentials to colab example ([ClearML GitHub PR #621](https://github.com/allegroai/clearml/pull/621)) +* Add jsonargparse support ([ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403)) * Update autokeras example **Bug Fixes** -* Fix sub-project separators are incorrectly quoted in generated URLs [ClearML GitHub PR #584](https://github.com/allegroai/clearml/pull/584) -* Revert Optuna deprecation fix [ClearML GitHub PR #613](https://github.com/allegroai/clearml/pull/613) +* Fix sub-project separators are incorrectly quoted in generated URLs ([ClearML GitHub PR #584](https://github.com/allegroai/clearml/pull/584)) +* Revert Optuna deprecation fix ([ClearML GitHub PR #613](https://github.com/allegroai/clearml/pull/613)) * Fix HPO randomly aborts running tasks before the time limit * Fix cloud driver overwrites `agent.extra_docker_arguments` * Fix Pipeline Controller auto-magic framework connect @@ -75,9 +75,9 @@ title: Version 1.3 **Bug Fixes** -* Update Slack SDK requirement [ClearML GitHub issue #597](https://github.com/allegroai/clearml/issues/597) -* Fix fork after `task.close()` is called [ClearML GitHub issue #605](https://github.com/allegroai/clearml/issues/605) -* Fix Azure storage upload [ClearML GitHub issue #598](https://github.com/allegroai/clearml/issues/598) +* Update Slack SDK requirement ([ClearML GitHub issue #597](https://github.com/allegroai/clearml/issues/597)) +* Fix fork after `task.close()` is called ([ClearML GitHub issue #605](https://github.com/allegroai/clearml/issues/605)) +* Fix Azure storage upload ([ClearML GitHub issue #598](https://github.com/allegroai/clearml/issues/598)) * Fix offline mode crash * Fix task delete response not checked * Fix pipeline controller kwargs with list @@ -97,9 +97,9 @@ title: Version 1.3 * Pipelines statistics dashboard * Pipeline run history: View pipeline structure, run configuration and outputs * Pipeline control: Abort/Run pipelines from UI -* Add support for exporting UI table plots in CSV formats [ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400) -* Improve UI breadcrumbs use of screen real-estate [ClearML GitHub issue #529](https://github.com/allegroai/clearml/issues/529) -* Add UI adherence to user specification of plot colors and labels [ClearML GitHub issue #518](https://github.com/allegroai/clearml/issues/518) +* Add support for exporting UI table plots in CSV formats ([ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400)) +* Improve UI breadcrumbs use of screen real-estate ([ClearML GitHub issue #529](https://github.com/allegroai/clearml/issues/529)) +* Add UI adherence to user specification of plot colors and labels ([ClearML GitHub issue #518](https://github.com/allegroai/clearml/issues/518)) * Add Model metadata to UI model information (Model table and details page) * Add multi-selection in UI experiment info-panel mode * Add labels to workspace credentials @@ -108,7 +108,7 @@ title: Version 1.3 * Add Previous/Next controls to UI text area search bars **Bug Fixes** -* Fix UI plots do not display Plotly `imshow texttemplate` [ClearML GitHub issue #538](https://github.com/allegroai/clearml/issues/538) +* Fix UI plots do not display Plotly `imshow texttemplate` ([ClearML GitHub issue #538](https://github.com/allegroai/clearml/issues/538)) * Fix clicking F5 clears storage credentials from UI settings page * Fix UI plots "Wall time" horizontal axis option is not working * Fix disappearing UI full-screen scalar plot @@ -133,6 +133,6 @@ title: Version 1.3 **Bug Fixes** -* Fix failed catboost bind on GPU [ClearML GitHub issue #592](https://github.com/allegroai/clearml/issues/592) +* Fix failed catboost bind on GPU ([ClearML GitHub issue #592](https://github.com/allegroai/clearml/issues/592)) * Fix Optuna `n_jobs` deprecation warning * Fix invalid method called on `delete()` error diff --git a/docs/release_notes/ver_1_4.md b/docs/release_notes/ver_1_4.md index d10936ab..9dba628b 100644 --- a/docs/release_notes/ver_1_4.md +++ b/docs/release_notes/ver_1_4.md @@ -42,21 +42,21 @@ title: Version 1.4 * Fix template namespace should override default namespace * Fix `extra_bash_init_cmd` location in initial bash script * Fix debug mode -* Fixed documentation [ClearML Agent PR #117](https://github.com/allegroai/clearml-agent/pull/117) +* Fixed documentation ([ClearML Agent PR #117](https://github.com/allegroai/clearml-agent/pull/117)) ### ClearML SDK 1.4.1 **Bug Fixes** -* Fix Process Pool hangs at exit [ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674) +* Fix Process Pool hangs at exit ([ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674)) ### ClearML SDK 1.4.0 **New Features** -* Add OpenMMLab example [ClearML GitHub issue #654](https://github.com/allegroai/clearml/issues/654) -* Add support for saving artifacts with different formats [ClearML GitHub issue #634](https://github.com/allegroai/clearml/issues/634) -* Add support for setting reported values for `NaN` and `Inf` [ClearML GitHub issue #604](https://github.com/allegroai/clearml/issues/604) -* Support more than 500 results in `Task.get_tasks()` using the `fetch_only_first_page` argument [ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612) -* Support links in `clearml-data` [ClearML GitHub issue #585](https://github.com/allegroai/clearml/issues/585) +* Add OpenMMLab example ([ClearML GitHub issue #654](https://github.com/allegroai/clearml/issues/654)) +* Add support for saving artifacts with different formats ([ClearML GitHub issue #634](https://github.com/allegroai/clearml/issues/634)) +* Add support for setting reported values for `NaN` and `Inf` ([ClearML GitHub issue #604](https://github.com/allegroai/clearml/issues/604)) +* Support more than 500 results in `Task.get_tasks()` using the `fetch_only_first_page` argument ([ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612)) +* Support links in `clearml-data` ([ClearML GitHub issue #585](https://github.com/allegroai/clearml/issues/585)) * Support deferred task initialization using `Task.init()` argument `deferred_init` (beta feature) * Support resuming experiments when importing an Offline session * Add `--import-offline-session` command line option to `clearml-task` @@ -70,15 +70,15 @@ title: Version 1.4 * Improve Dataset version table * Add warning to Dataset creation on current Task * Examples and documentation - * Add manual seaborn logging example [ClearML GitHub PR #628](https://github.com/allegroai/clearml/pull/628) + * Add manual seaborn logging example ([ClearML GitHub PR #628](https://github.com/allegroai/clearml/pull/628)) * Change package author - * Change pipeline example to run locally [ClearML GitHub PR #642](https://github.com/allegroai/clearml/pull/642) - * Update PyTorch Lightning example for `pytorch-lightning>=v1.6.0` [ClearML GitHub PR #650](https://github.com/allegroai/clearml/pull/650) + * Change pipeline example to run locally ([ClearML GitHub PR #642](https://github.com/allegroai/clearml/pull/642)) + * Update PyTorch Lightning example for `pytorch-lightning>=v1.6.0` ([ClearML GitHub PR #650](https://github.com/allegroai/clearml/pull/650)) **Bug Fixes** -* Fix Keras model config serialization in `PatchKerasModelIO` [ClearML GitHub issue #614](https://github.com/allegroai/clearml/issues/614) -* Fix `task.get_parameters_as_dict(cast=True)` casts `False` to `True` [ClearML GitHub PR #622](https://github.com/allegroai/clearml/pull/622) -* Fix Fire integration is not compatible with typing library [ClearML GitHub issue #610](https://github.com/allegroai/clearml/issues/610) +* Fix Keras model config serialization in `PatchKerasModelIO` ([ClearML GitHub issue #614](https://github.com/allegroai/clearml/issues/614)) +* Fix `task.get_parameters_as_dict(cast=True)` casts `False` to `True` ([ClearML GitHub PR #622](https://github.com/allegroai/clearml/pull/622)) +* Fix Fire integration is not compatible with typing library ([ClearML GitHub issue #610](https://github.com/allegroai/clearml/issues/610)) * Fix remote execution with `argparse` mutually exclusive groups raises "required" error even when no argument is required * Fix Hydra tasks never fail and are only set to completed (fix handling return code) * Fix `clearml-data` wildcard support @@ -106,28 +106,28 @@ title: Version 1.4 **New Features and Improvements** -- Allow serving with a URL path prefix [ClearML Server GitHub issue #119](https://github.com/allegroai/clearml-server/issues/119) -- Allow overriding clearml web git url on build [ClearML Server GitHub Pull Request #122](https://github.com/allegroai/clearml-server/pull/122) -- Ensure agent-services waits for API server to be ready [ClearML Server GitHub issue #113](https://github.com/allegroai/clearml-server/issues/113) -- Add filter to UI experiment table "Project" column [ClearML GitHub issue #529](https://github.com/allegroai/clearml/issues/529) +- Allow serving with a URL path prefix ([ClearML Server GitHub issue #119](https://github.com/allegroai/clearml-server/issues/119)) +- Allow overriding clearml web git url on build ([ClearML Server GitHub Pull Request #122](https://github.com/allegroai/clearml-server/pull/122)) +- Ensure agent-services waits for API server to be ready ([ClearML Server GitHub issue #113](https://github.com/allegroai/clearml-server/issues/113)) +- Add filter to UI experiment table "Project" column ([ClearML GitHub issue #529](https://github.com/allegroai/clearml/issues/529)) - Add filters to UI model table custom metadata columns - Improve UI table object selection. Add buttons and context menu actions to switch between table and info panel mode -- Add task detail header to UI experiment comparison debug image section addressed in [ClearML GitHub issue #81](https://github.com/allegroai/clearml/issues/81) ([comment](https://github.com/allegroai/clearml/issues/81#issuecomment-996841658)) -- Improve series name truncation behavior in UI scalar plots [ClearML GitHub issue #562](https://github.com/allegroai/clearml/issues/562) +- Add task detail header to UI experiment comparison debug image section addressed in ([ClearML GitHub issue #81](https://github.com/allegroai/clearml/issues/81) ([comment](https://github.com/allegroai/clearml/issues/81#issuecomment-996841658))) +- Improve series name truncation behavior in UI scalar plots ([ClearML GitHub issue #562](https://github.com/allegroai/clearml/issues/562)) **Bug Fixes** -- Fix server limiting image and artifact upload size [ClearML GitHub issue #606](https://github.com/allegroai/clearml/issues/606) -- Fix server unnecessarily displays deletion error message [ClearML Server GitHub issue #112](https://github.com/allegroai/clearml-server/issues/112) -- Fix UI experiment comparison sections overly wide for many tag experiments [ClearML GitHub issue #594](https://github.com/allegroai/clearml/issues/594) +- Fix server limiting image and artifact upload size ([ClearML GitHub issue #606](https://github.com/allegroai/clearml/issues/606)) +- Fix server unnecessarily displays deletion error message ([ClearML Server GitHub issue #112](https://github.com/allegroai/clearml-server/issues/112)) +- Fix UI experiment comparison sections overly wide for many tag experiments ([ClearML GitHub issue #594](https://github.com/allegroai/clearml/issues/594)) - Fix model name display in UI pipeline run info panel - Fix UI pipeline run info panel missing artifacts and models sections - Fix UI pipeline run info panel displays unneeded resource utilization metrics - Fix UI project cards missing task summary values - Fix pipeline tag colors can't be changed in UI pipeline page -- Fix pipeline run UI page not displaying pipeline steps [ClearML GitHub issue #618](https://github.com/allegroai/clearml/issues/618) +- Fix pipeline run UI page not displaying pipeline steps ([ClearML GitHub issue #618](https://github.com/allegroai/clearml/issues/618)) - Fix breadcrumb links don't navigate anywhere - Fix horizontal scroll in UI experiment table causes column headers to jump - Fix removing UI table column creates a blank column -- Fix internal server error (500) on `events.get_scalar_metrics_and_variants` [ClearML Server GitHub issue #120](https://github.com/allegroai/clearml-server/issues/120) +- Fix internal server error (500) on `events.get_scalar_metrics_and_variants` ([ClearML Server GitHub issue #120](https://github.com/allegroai/clearml-server/issues/120)) diff --git a/docs/release_notes/ver_1_5.md b/docs/release_notes/ver_1_5.md index 86478d48..edd84a50 100644 --- a/docs/release_notes/ver_1_5.md +++ b/docs/release_notes/ver_1_5.md @@ -5,14 +5,14 @@ title: Version 1.5 ### ClearML Agent 1.5.2 **New Features and Improvements** -* Switch services agent entrypoint shell from sh to bash [ClearML Agent GitHub issue #140](https://github.com/allegroai/clearml-agent/issues/140) +* Switch services agent entrypoint shell from sh to bash ([ClearML Agent GitHub issue #140](https://github.com/allegroai/clearml-agent/issues/140)) * Improve poetry support -* Add poetry cwd support [ClearML Agent GitHub issue #138](https://github.com/allegroai/clearml-agent/issues/138) +* Add poetry cwd support ([ClearML Agent GitHub issue #138](https://github.com/allegroai/clearml-agent/issues/138)) * Add `agent.package_manager.poetry_install_extra_args` configuration option * Do not allow request exceptions (keep retrying, throw error only on the initial login call) **Bug Fixes** -* Fix agent update version [ClearML Agent GitHub PR #132](https://github.com/allegroai/clearml-agent/pull/132) +* Fix agent update version ([ClearML Agent GitHub PR #132](https://github.com/allegroai/clearml-agent/pull/132)) * Fix login uses `GET` with payload, which breaks when trying to connect a server running in GCP * Fix `clearml-agent build --docker` stuck on certain containers * Fix build fails when target is relative path @@ -25,7 +25,7 @@ title: Version 1.5 ### ClearML Agent 1.5.1 **New Features and Improvements** -* Upgrade requirements for `attrs`, `jsonschema`, `pyparsing`, `six`, and `pyjwt` [ClearML Agent GitHub issue #129](https://github.com/allegroai/clearml-agent/issues/129) +* Upgrade requirements for `attrs`, `jsonschema`, `pyparsing`, `six`, and `pyjwt` ([ClearML Agent GitHub issue #129](https://github.com/allegroai/clearml-agent/issues/129)) * Add default output URI selection to `clearml-agent init` * Add `agent.disable_task_docker_override` configuration option to disable docker override specified in executing tasks * Add `CLEARML_AGENT_FORCE_SYSTEM_SITE_PACKAGES` env var (default `true`) to allow overriding default `system_site_packages: true` @@ -39,7 +39,7 @@ since 4.0.0) ### ClearML Agent 1.5.0 **New Features and Improvements** -* Add option to crash agent on exception using `agent.crash_on_exception` configuration setting [ClearML Agent GitHub issue #122](https://github.com/allegroai/clearml-agent/issues/122) +* Add option to crash agent on exception using `agent.crash_on_exception` configuration setting ([ClearML Agent GitHub issue #122](https://github.com/allegroai/clearml-agent/issues/122)) * Improve venv cache disabled message * Upgrade packages for better Python 3.10 support * Remove future package dependency (Python 2 is not supported for `clearml-agent`) @@ -68,19 +68,19 @@ for user/password when cloning/fetching repositories) ### ClearML SDK 1.5.0 **New Features and Improvements** -* Add support for single value metric reporting ClearML GitHub issue [ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400) -* Add support for specifying parameter sections in `PipelineDecorator` [ClearML GitHub issue #629](https://github.com/allegroai/clearml/issues/629) +* Add support for single value metric reporting ClearML GitHub issue ([ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400)) +* Add support for specifying parameter sections in `PipelineDecorator` ([ClearML GitHub issue #629](https://github.com/allegroai/clearml/issues/629)) * Add support for parallel uploads and downloads (upload / download and zip / unzip of artifacts) * Add support for specifying execution details (repository, branch, commit, packages, image) in `PipelineDecorator` * Bump PyJWT version due to "*Key confusion through non-blocklisted public key formats*" vulnerability * Add support for AWS Session Token (using boto3's `aws_session_token` argument) **Bug Fixes** -* Fix `Task.get_projects()` retrieves only the first 500 results [ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612) -* Fix failure to delete artifacts stored in Azure [ClearML GitHub issue #660](https://github.com/allegroai/clearml/issues/660) -* Fix Process Pool hangs at exit [ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674) -* Fix number of unpacked values when syncing a dataset [ClearML GitHub issue #682](https://github.com/allegroai/clearml/issues/682) -* Fix FastAI DeprecationWarning [ClearML GitHub PR #683](https://github.com/allegroai/clearml/issues/683) +* Fix `Task.get_projects()` retrieves only the first 500 results ([ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612)) +* Fix failure to delete artifacts stored in Azure ([ClearML GitHub issue #660](https://github.com/allegroai/clearml/issues/660)) +* Fix Process Pool hangs at exit ([ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674)) +* Fix number of unpacked values when syncing a dataset ([ClearML GitHub issue #682](https://github.com/allegroai/clearml/issues/682)) +* Fix FastAI DeprecationWarning ([ClearML GitHub PR #683](https://github.com/allegroai/clearml/issues/683)) * Fix `StorageManager.download_folder()` crash * Fix pipelines can't handle `None` return value * Fix pre-existing pipeline raises an exception @@ -100,8 +100,8 @@ for user/password when cloning/fetching repositories) * Redesign experiment status banner * Display all experiment tabs in single line * Move experiment action buttons to the top right -* Add UI adherence to user specified plot dimensions [ClearML GitHub issue #587](https://github.com/allegroai/clearml/issues/587) -* Add row highlight to experiment textual comparison UI [ClearML GitHub issue #581](https://github.com/allegroai/clearml/issues/581) +* Add UI adherence to user specified plot dimensions ([ClearML GitHub issue #587](https://github.com/allegroai/clearml/issues/587)) +* Add row highlight to experiment textual comparison UI ([ClearML GitHub issue #581](https://github.com/allegroai/clearml/issues/581)) * Add UI "Delete" action for Pipelines * Add UI indicator for task and pipeline progress * Add UI API credentials label "Edit" action @@ -110,8 +110,8 @@ for user/password when cloning/fetching repositories) * Add pipeline results to UI dashboard search **Bug Fixes** -* Fix UI experiment debug samples disappearing after refresh [ClearML Server GitHub issue #136](https://github.com/allegroai/clearml-server/issues/136) -* Fix deleting tasks sometimes raises errors [ClearML GitHub issue #632](https://github.com/allegroai/clearml/issues/632) +* Fix UI experiment debug samples disappearing after refresh ([ClearML Server GitHub issue #136](https://github.com/allegroai/clearml-server/issues/136)) +* Fix deleting tasks sometimes raises errors ([ClearML GitHub issue #632](https://github.com/allegroai/clearml/issues/632)) * Fix only partial task log shown when running on ES with multiple shards * Fix move task to trash is not thread-safe * Fix UI Project overview metric snapshot not showing diff --git a/docs/release_notes/ver_1_6.md b/docs/release_notes/ver_1_6.md index 0b077f79..e944555d 100644 --- a/docs/release_notes/ver_1_6.md +++ b/docs/release_notes/ver_1_6.md @@ -10,10 +10,10 @@ title: Version 1.6 ### ClearML Agent 1.6.0 **New Features and Improvements** -* Upgrade `requests` library [ClearML Agent GitHub issue #161](https://github.com/allegroai/clearml-agent/issues/161) +* Upgrade `requests` library ([ClearML Agent GitHub issue #161](https://github.com/allegroai/clearml-agent/issues/161)) * Add support for controlling PyTorch resolving mode using the `CLEARML_AGENT_PACKAGE_PYTORCH_RESOLVE` environment variable and `agent.package_manager.pytorch_resolve configuration` setting with `none` (no resolving), `pip` (sets extra -index based on cuda and lets pip resolve) or `direct` (the previous parsing algorithm that does the matching and downloading). Default is `pip` [ClearML Agent GitHub issue #152](https://github.com/allegroai/clearml-agent/issues/152) +index based on cuda and lets pip resolve) or `direct` (the previous parsing algorithm that does the matching and downloading). Default is `pip` ([ClearML Agent GitHub issue #152](https://github.com/allegroai/clearml-agent/issues/152)) * Add backwards compatibility in standalone mode using the `CLEARML_AGENT_STANDALONE_CONFIG_BC` environment variable * Add `CLEARML_AGENT_DOCKER_AGENT_REPO` alias for the `FORCE_CLEARML_AGENT_REPO` environment variable * Show a better message for `agent init` when an existing `clearml.conf` is found @@ -47,7 +47,7 @@ configuration option, allowing users to use `$ENV` in the task docker arguments ### ClearML SDK 1.6.3 **New Features and Improvements** -* Add option to specify an endpoint URL when creating S3 resource service [ClearML GitHub issue #673](https://github.com/allegroai/clearml/issues/673) +* Add option to specify an endpoint URL when creating S3 resource service ([ClearML GitHub issue #673](https://github.com/allegroai/clearml/issues/673)) * Add support for providing `ExtraArgs` to boto3 when uploading files using the `sdk.aws.s3.extra_args` configuration option * Add support for Server API 2.20 * Add `Task.get_num_enqueued_tasks()` to get the number of tasks enqueued in a specific queue @@ -62,12 +62,12 @@ configuration option, allowing users to use `$ENV` in the task docker arguments * Add wild-card support in `clearml-data` **Bug Fixes** -* Fix dataset download [ClearML GitHub issue #713](https://github.com/allegroai/clearml/issues/713) -* Fix lock is not released after dataset cache is downloaded [ClearML GitHub issue #671](https://github.com/allegroai/clearml/issues/671) -* Fix deadlock might occur when using process pool large number processes [ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674) -* Fix 'series' not appearing on UI when using `logger.report_table()` [ClearML GitHub issue #684](https://github.com/allegroai/clearml/issues/684) -* Fix `Task.init()` docstring to include behavior when executing remotely [ClearML GitHub PR #737](https://github.com/allegroai/clearml/pull/737) -* Fix `KeyError` when running remotely and no params were passed to click [ClearML Agent GitHub issue #111](https://github.com/allegroai/clearml-agent/issues/111) +* Fix dataset download ([ClearML GitHub issue #713](https://github.com/allegroai/clearml/issues/713)) +* Fix lock is not released after dataset cache is downloaded ([ClearML GitHub issue #671](https://github.com/allegroai/clearml/issues/671)) +* Fix deadlock might occur when using process pool large number processes ([ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674)) +* Fix 'series' not appearing on UI when using `logger.report_table()` ([ClearML GitHub issue #684](https://github.com/allegroai/clearml/issues/684)) +* Fix `Task.init()` docstring to include behavior when executing remotely ([ClearML GitHub PR #737](https://github.com/allegroai/clearml/pull/737)) +* Fix `KeyError` when running remotely and no params were passed to click ([ClearML Agent GitHub issue #111](https://github.com/allegroai/clearml-agent/issues/111)) * Fix full path is stored when uploading a single artifact file * Fix passing non-alphanumeric filename in `sdk.development.detect_with_pip_freeze` * Fix Python 3.6 and 3.10 support @@ -97,14 +97,14 @@ configuration option, allowing users to use `$ENV` in the task docker arguments ### ClearML Server 1.6.0 **New Features and Improvements** * New ClearML Datasets UI pages for tracking dataset versions and exploring version lineage and contents -* Add history navigation to experiments plots UI page [ClearML GitHub issues #81](https://github.com/allegroai/clearml/issues/81) and [#255](https://github.com/allegroai/clearml/issues/255): +* Add history navigation to experiments plots UI page ([ClearML GitHub issues #81](https://github.com/allegroai/clearml/issues/81) and [#255](https://github.com/allegroai/clearml/issues/255)): * Plots page shows last reported plot for each metric/variation combination * Single plot view provides history navigation slider * Add single value scalar reporting: Single value scalars are aggregated into a summary table in the experiment's scalars - UI page [ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400) -* Add "show hidden projects" control [ClearML GitHub issue #694](https://github.com/allegroai/clearml/issues/694) + UI page ([ClearML GitHub issue #400](https://github.com/allegroai/clearml/issues/400)) +* Add "show hidden projects" control ([ClearML GitHub issue #694](https://github.com/allegroai/clearml/issues/694)) * Improve UI projects page setting persistence - User's last chosen settings for recent/name sorting and team/personal - filter is saved [ClearML GitHub issue #353](https://github.com/allegroai/clearml/issues/353) + filter is saved ([ClearML GitHub issue #353](https://github.com/allegroai/clearml/issues/353)) * Improve UI presentation for object IDs: * Display shortened ID next to task name * Display full ID in tooltip @@ -118,9 +118,9 @@ configuration option, allowing users to use `$ENV` in the task docker arguments * Maintain UI viewing mode when restoring archived items **Bug Fixes** -* Fix experiment selection with 'Shift' key in UI experiment table not working [ClearML Server GitHub issue #139](https://github.com/allegroai/clearml-server/issues/139) -* Fix UI search error message interferes with inputting search query [ClearML Server GitHub issue #138](https://github.com/allegroai/clearml-server/issues/138) -* Fix refresh breaks UI breadcrumbs ClearML Server [ClearML Server GitHub issue #142](https://github.com/allegroai/clearml-server/issues/142) +* Fix experiment selection with 'Shift' key in UI experiment table not working ([ClearML Server GitHub issue #139](https://github.com/allegroai/clearml-server/issues/139)) +* Fix UI search error message interferes with inputting search query ([ClearML Server GitHub issue #138](https://github.com/allegroai/clearml-server/issues/138)) +* Fix refresh breaks UI breadcrumbs ClearML Server ([ClearML Server GitHub issue #142](https://github.com/allegroai/clearml-server/issues/142)) * Fix UI Workers and Queues page displays incorrect queue metrics * Fix failure to publish models whose generating task was reset * Fix listed models in UI pipeline run info panel doesn't link to model @@ -161,7 +161,7 @@ configuration option, allowing users to use `$ENV` in the task docker arguments **Bug Fix** -* Fix format string construction sometimes causing delayed evaluation errors [ClearML GitHub issue #706](https://github.com/allegroai/clearml/issues/706) +* Fix format string construction sometimes causing delayed evaluation errors ([ClearML GitHub issue #706](https://github.com/allegroai/clearml/issues/706)) ### ClearML SDK 1.6.1 @@ -183,7 +183,7 @@ configuration option, allowing users to use `$ENV` in the task docker arguments **Bug Fixes** * Fix axis range settings when logging plots -* Fix `Task.get_project()` to return more than 500 entries [ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612) +* Fix `Task.get_project()` to return more than 500 entries ([ClearML GitHub issue #612](https://github.com/allegroai/clearml/issues/612)) * Fix pipeline progress calculation * Fix `StorageManager.upload_folder()` returns `None` for both successful and unsuccessful uploads * Fix script path capturing stores a relative path and not an absolute path diff --git a/docs/release_notes/ver_1_7.md b/docs/release_notes/ver_1_7.md index 18b19b2e..8ed61166 100644 --- a/docs/release_notes/ver_1_7.md +++ b/docs/release_notes/ver_1_7.md @@ -22,7 +22,7 @@ log files (daemon and execution) * Set worker ID in k8s pod execution **Bug Fixes** -* Fix `agent.package_manager.poetry_install_extra_args` are used in all Poetry commands and not just in `install` [ClearML Agent GitHub issue #173](https://github.com/allegroai/clearml-agent/issues/173) +* Fix `agent.package_manager.poetry_install_extra_args` are used in all Poetry commands and not just in `install` ([ClearML Agent GitHub issue #173](https://github.com/allegroai/clearml-agent/issues/173)) * Fix if process return code is SIGKILL (-9 or 137) and abort callback was called, do not mark as failed but as aborted * Fix `agent.git_host` setting will cause git@domain URLs to not be replaced by SSH URLs since furl cannot parse them to obtain host @@ -39,14 +39,14 @@ an empty string * Support running Jupyter Notebook inside a git repository (repository will be referenced without uncommitted changes and Jupyter Notebook will be stored on plain code as uncommitted changes) * Add Jupyter Notebook fail warning -* Allow pipeline steps to return string paths without them being treated as a folder artifact and zipped [ClearML GitHub issue #780](https://github.com/allegroai/clearml/issues/780) +* Allow pipeline steps to return string paths without them being treated as a folder artifact and zipped ([ClearML GitHub issue #780](https://github.com/allegroai/clearml/issues/780)) * Remove `future` from Python 3 requirements **Bug Fixes** -* Fix exception raised when using `ThreadPool` [ClearML GitHub issue #790](https://github.com/allegroai/clearml/issues/790) -* Fix Pyplot/Matplotlib binding reports incorrect line labels and colors [ClearML GitHub issue #791](https://github.com/allegroai/clearml/issues/791) +* Fix exception raised when using `ThreadPool` ([ClearML GitHub issue #790](https://github.com/allegroai/clearml/issues/790)) +* Fix Pyplot/Matplotlib binding reports incorrect line labels and colors ([ClearML GitHub issue #791](https://github.com/allegroai/clearml/issues/791)) * Pipelines - * Fix crash when running cloned pipeline that invokes a step twice [ClearML GitHub issue #769](https://github.com/allegroai/clearml/issues/769) + * Fix crash when running cloned pipeline that invokes a step twice ([ClearML GitHub issue #769](https://github.com/allegroai/clearml/issues/769)) * Fix pipeline argument becomes `None` if default value is not set * Fix `retry_on_failure` callback does nothing when specified on `PipelineController.add_step()` * Fix pipeline clone logic @@ -55,14 +55,14 @@ an empty string * Fix issue with old/new notebook packages installed * Fix local cache with access rules disabling partial local access * Fix `Task.upload_artifact()` fails uploading pandas `DataFrame` -* Fix relative paths in examples [ClearML GitHub PR #787](https://github.com/allegroai/clearml/issues/787) +* Fix relative paths in examples ([ClearML GitHub PR #787](https://github.com/allegroai/clearml/issues/787) ### ClearML Server 1.7.0 **New Features and Improvements** -* Add “Sync comparison” to UI experiment debug samples comparison: Control metric/iteration for all compared experiments [ClearML GitHub issue #691](https://github.com/allegroai/clearml/issues/691) -* Support serving UI from a non-root path of the ClearML Server [ClearML Helm Charts issue #101](https://github.com/allegroai/clearml-helm-charts/issues/101) and [ClearML Server issue #135](https://github.com/allegroai/clearml-server/issues/135). -* Add UI option for hiding “secret” experiment container arguments [ClearML Server GitHub issue #146](https://github.com/allegroai/clearml-server/issues/146) -* Add UI tables switch to detail mode through double-click [ClearML Server GitHub issue #134](https://github.com/allegroai/clearml-server/issues/134) +* Add “Sync comparison” to UI experiment debug samples comparison: Control metric/iteration for all compared experiments ([ClearML GitHub issue #691](https://github.com/allegroai/clearml/issues/691)) +* Support serving UI from a non-root path of the ClearML Server ([ClearML Helm Charts issue #101](https://github.com/allegroai/clearml-helm-charts/issues/101) and [ClearML Server issue #135](https://github.com/allegroai/clearml-server/issues/135)) +* Add UI option for hiding “secret” experiment container arguments ([ClearML Server GitHub issue #146](https://github.com/allegroai/clearml-server/issues/146)) +* Add UI tables switch to detail mode through double-click ([ClearML Server GitHub issue #134](https://github.com/allegroai/clearml-server/issues/134)) * Add customizable user activity timeout for UI logout * Add UI navigation from experiment comparison back to originating experiment table * Improve UI scalar comparison graph configuration - Persist user's choice for viewing graph data. @@ -70,8 +70,8 @@ an empty string * Add dataset description to UI dataset information display **Bug Fixes** -* Fix UI experiment Hyperparameter tab's inefficient use of screen real estate [ClearML GitHub issue #705](https://github.com/allegroai/clearml/issues/705) -* Fix navigating to an archived experiment's configuration causes UI to return to non-archived view [ClearML Server GitHub issue #148](https://github.com/allegroai/clearml-server/issues/148) +* Fix UI experiment Hyperparameter tab's inefficient use of screen real estate ([ClearML GitHub issue #705](https://github.com/allegroai/clearml/issues/705)) +* Fix navigating to an archived experiment's configuration causes UI to return to non-archived view ([ClearML Server GitHub issue #148](https://github.com/allegroai/clearml-server/issues/148)) * Fix metric storage failure when large amount of metrics logged * Fix UI plots downloaded as PNGs don't contain legends * Fix UI plot colors can't be changed when colors are specified in code @@ -105,7 +105,7 @@ an empty string **New Features and Improvements** * ClearML Data: Support providing list of links -* Upload artifacts with a custom serializer [ClearML GitHub issue #689](https://github.com/allegroai/clearml/issues/689) +* Upload artifacts with a custom serializer ([ClearML GitHub issue #689](https://github.com/allegroai/clearml/issues/689)) * Allow user to specify extension when using custom serializer functions (for artifacts) * Skip server URL verification in `clearml-init` wizard process * When calling `Dataset.get()` without "alias" field, tell user that he can use alias to log it in the UI @@ -116,18 +116,18 @@ an empty string * Add `Task.register_abort_callback` **Bug Fixes** -* Allow getting datasets with non-semantic versioning [ClearML GitHub issue #776](https://github.com/allegroai/clearml/issues/776) +* Allow getting datasets with non-semantic versioning ([ClearML GitHub issue #776](https://github.com/allegroai/clearml/issues/776)) * Fix interactive plots (instead of a generated png) * Fix Python 2.7 support * Fix clearml datasets `list` functionality * Fix `Dataset.init` to not modify task (to `Dataset.create`) * Fix failure with large files upload on HTTPS * Fix 3d plots with plt shows 2d plot on task results page -* Fix uploading files with project's `default_upload_destination` [ClearML GitHub issue #734](https://github.com/allegroai/clearml/issues/734) +* Fix uploading files with project's `default_upload_destination` ([ClearML GitHub issue #734](https://github.com/allegroai/clearml/issues/734)) * Fix broken Matplotlib reporting - using logarithmic scale breaks reporting * Fix wildcard support in `clearml-data` CLI -* Fix `report_histogram` - does not show "horizontal" orientation [ClearML GitHub issue 699](https://github.com/allegroai/clearml/issues/699) -* Fix table reporting - when using `logger.report_table(title, series, iteration, etc)`, the `series` arg does not appear in UI [ClearML GitHub issue 684](https://github.com/allegroai/clearml/issues/684) +* Fix `report_histogram` - does not show "horizontal" orientation ([ClearML GitHub issue 699](https://github.com/allegroai/clearml/issues/699)) +* Fix table reporting - when using `logger.report_table(title, series, iteration, etc)`, the `series` arg does not appear in UI ([ClearML GitHub issue 684](https://github.com/allegroai/clearml/issues/684)) * Fix artifacts (and models) use task's original name and not new name * Fix very long filenames from s3 can't be downloaded (with `get_local_copy()`) -* Fix overwrite of existing output models on pipeline task with `monitor_models` [ClearML GitHub issue #757](https://github.com/allegroai/clearml/issues/757) \ No newline at end of file +* Fix overwrite of existing output models on pipeline task with `monitor_models` ([ClearML GitHub issue #757](https://github.com/allegroai/clearml/issues/757)) \ No newline at end of file diff --git a/docs/release_notes/ver_1_8.md b/docs/release_notes/ver_1_8.md index 6b0c5b0c..bb82e591 100644 --- a/docs/release_notes/ver_1_8.md +++ b/docs/release_notes/ver_1_8.md @@ -5,7 +5,7 @@ title: Version 1.8 ### ClearML Agent 1.8.1 **New Features** -* Add option to set daemon polling interval [ClearML Agent GitHub PR #197](https://github.com/allegroai/clearml-agent/pull/197) +* Add option to set daemon polling interval ([ClearML Agent GitHub PR #197](https://github.com/allegroai/clearml-agent/pull/197)) * Add Python 3.12 support **Bug Fixes** @@ -31,9 +31,9 @@ specified and the code is running a preinstalled docker * Improve GPU monitoring for MIGs **Bug Fixes** -* Use correct Python version in Poetry init [ClearML Agent GitHub PR #179](https://github.com/allegroai/clearml-agent/pull/179) -* Fix queue handling in `K8sIntegration` and `k8s_glue_example.py` [ClearML Agent GitHub PR #183](https://github.com/allegroai/clearml-agent/pull/183) -* Fix `FileNotFoundException` crash in `find_python_executable_for_version` [ClearML Agent GitHub issue #164](https://github.com/allegroai/clearml-agent/issues/164) +* Use correct Python version in Poetry init ([ClearML Agent GitHub PR #179](https://github.com/allegroai/clearml-agent/pull/179)) +* Fix queue handling in `K8sIntegration` and `k8s_glue_example.py` ([ClearML Agent GitHub PR #183](https://github.com/allegroai/clearml-agent/pull/183)) +* Fix `FileNotFoundException` crash in `find_python_executable_for_version` ([ClearML Agent GitHub issue #164](https://github.com/allegroai/clearml-agent/issues/164)) * Fix delete temp console pipe log files after Task execution is completed (important for long-lasting services agents to avoid collecting temp files on host machine) * Fix `agent.enable_git_ask_pass` does not show in configuration dump * Fix `pip` is returned as a pip version if no value exists in `agent.package_manager.pip_version` @@ -46,7 +46,7 @@ specified and the code is running a preinstalled docker ### ClearML SDK 1.8.3 **Bug Fixes** -* Set GCS credentials to `None` if invalid service account credentials are provided [ClearML GitHub issue #840](https://github.com/allegroai/clearml/issues/840) +* Set GCS credentials to `None` if invalid service account credentials are provided ([ClearML GitHub issue #840](https://github.com/allegroai/clearml/issues/840)) * Fix a sync issue when loading deferred configuration ### ClearML SDK 1.8.2 @@ -61,18 +61,18 @@ specified and the code is running a preinstalled docker ### ClearML Server 1.8.0 **New Features and Improvements** -* Support `/` delimited project names for on-the-fly nested project creation in UI operations [ClearML Server GitHub issue #151](https://github.com/allegroai/clearml-server/issues/151) +* Support `/` delimited project names for on-the-fly nested project creation in UI operations ([ClearML Server GitHub issue #151](https://github.com/allegroai/clearml-server/issues/151)) * Add keyboard shortcut iteration navigation in full screen view of debug samples and plots -* Add "Don't show again" option for UI notification when archiving tasks [ClearML Server GitHub issue #149](https://github.com/allegroai/clearml-server/issues/149) +* Add "Don't show again" option for UI notification when archiving tasks ([ClearML Server GitHub issue #149](https://github.com/allegroai/clearml-server/issues/149)) * Add task reset/delete modal automatically closes when no additional information is provided * Add parent project name in UI dataset and pipeline cards * Move UI plot legends to bottom of plot **Bug Fixes** -* Fix task artifacts not deleted from file server when task deleted via UI [ClearML GitHub issue #801](https://github.com/allegroai/clearml/issues/801) -* Fix deleting pipeline projects via UI fails [ClearML GitHub issue #798](https://github.com/allegroai/clearml/issues/798) -* Fix multiple selection with `Shift` key in UI experiment table not working [ClearML Server GitHub issue #139](https://github.com/allegroai/clearml-server/issues/139) -* Fix disappearing user filter in UI "All Experiments" table [ClearML Web GitHub issue #33](https://github.com/allegroai/clearml-web/issues/33) +* Fix task artifacts not deleted from file server when task deleted via UI ([ClearML GitHub issue #801](https://github.com/allegroai/clearml/issues/801)) +* Fix deleting pipeline projects via UI fails ([ClearML GitHub issue #798](https://github.com/allegroai/clearml/issues/798)) +* Fix multiple selection with `Shift` key in UI experiment table not working ([ClearML Server GitHub issue #139](https://github.com/allegroai/clearml-server/issues/139)) +* Fix disappearing user filter in UI "All Experiments" table ([ClearML Web GitHub issue #33](https://github.com/allegroai/clearml-web/issues/33)) * Fix UI Dashboard missing My Work / Team Work filter * Fix navigating to Scalars and Plots tabs in UI experiment comparison freezes browser * Fix project stats do not exclude dataset and annotation tasks @@ -86,8 +86,8 @@ specified and the code is running a preinstalled docker ### ClearML SDK 1.8.1 **New Features and Improvements** -* Raise error on failed uploads [ClearML GitHub issue #810](https://github.com/allegroai/clearml/issues/819) -* Add hyperdataset examples [ClearML GitHub PR #823](https://github.com/allegroai/clearml/commit/f6b9efe54e1246adba4036c56bc6e8a0bdb99948) +* Raise error on failed uploads ([ClearML GitHub issue #810](https://github.com/allegroai/clearml/issues/819)) +* Add hyperdataset examples ([ClearML GitHub PR #823](https://github.com/allegroai/clearml/commit/f6b9efe54e1246adba4036c56bc6e8a0bdb99948)) * Change `report_event_flush_threshold` default to 100 * Add `ModelInfo.weights_object()` to store callback access to the actual model object being stored (valid for both pre/post save calls, otherwise `None`) @@ -95,8 +95,8 @@ pre/post save calls, otherwise `None`) * Support max connections setting for Azure storage using the `sdk.azure.storage.max_connection` configuration option **Bug Fixes** -* Fix clearml logger default level cannot be changed [ClearML GitHub issue #741](https://github.com/allegroai/clearml/issues/741) -* Fix Hydra doesn't get overridden information from ClearML [ClearML GitHub issue #751](https://github.com/allegroai/clearml/issues/751) +* Fix clearml logger default level cannot be changed ([ClearML GitHub issue #741](https://github.com/allegroai/clearml/issues/741)) +* Fix Hydra doesn't get overridden information from ClearML ([ClearML GitHub issue #751](https://github.com/allegroai/clearml/issues/751)) * Fix `StorageManager.list(“s3://..”, with_metadata=True)` doesn't work * Fix `ModelsList.keys()` is missing * Fix `CLEARML_DEFERRED_TASK_INIT=1` doesn't work @@ -105,10 +105,10 @@ pre/post save calls, otherwise `None`) ### ClearML SDK 1.8.0 **New Features and Improvements** -* Add tarfile member sanitization to `extractall()`[ClearML GitHub PR #803](https://github.com/allegroai/clearml/pull/803) -* Add `Task.delete_artifacts()` with `raise_on_errors` argument [ClearML GitHub issue #805](https://github.com/allegroai/clearml/issues/805) -* Add CI/CD example [ClearML GitHub PR #815](https://github.com/allegroai/clearml/pull/815) -* Limit number of `_serialize` requests when adding list of links with `add_external_files()` [ClearML GitHub issue #813](https://github.com/allegroai/clearml/issues/813) +* Add tarfile member sanitization to `extractall()`([ClearML GitHub PR #803](https://github.com/allegroai/clearml/pull/803)) +* Add `Task.delete_artifacts()` with `raise_on_errors` argument ([ClearML GitHub issue #805](https://github.com/allegroai/clearml/issues/805)) +* Add CI/CD example ([ClearML GitHub PR #815](https://github.com/allegroai/clearml/pull/815)) +* Limit number of `_serialize` requests when adding list of links with `add_external_files()` ([ClearML GitHub issue #813](https://github.com/allegroai/clearml/issues/813)) * Add support for connecting Enum values as parameters * Improve Colab integration (store entire colab, not history) * Add `clearml.browser_login` to authenticate browser online sessions such as Colab, Jupyter Notebooks etc. @@ -120,7 +120,7 @@ pre/post save calls, otherwise `None`) **Bug Fixes** * Fix passing `compression=ZIP_STORED` (or 0) to `Dataset.upload()` uses `ZIP_DEFLATED` and overrides the user-supplied -argument [ClearML GitHub PR #812](https://github.com/allegroai/clearml/pull/812) +argument ([ClearML GitHub PR #812](https://github.com/allegroai/clearml/pull/812)) * Fix `unique_selector` is not applied properly on batches after the first batch. Remove default selector value since it does not work for all event types (and we always specify it anyway) * Fix `clearml-init` colab detection diff --git a/docs/release_notes/ver_1_9.md b/docs/release_notes/ver_1_9.md index 7630d13e..005ff535 100644 --- a/docs/release_notes/ver_1_9.md +++ b/docs/release_notes/ver_1_9.md @@ -6,22 +6,22 @@ title: Version 1.9 **Bug Fixes** * Fix broken `Task._get_status()`, which was breaking `clearml-session` in the latest version -* Fix path substitution, making it possible to store unsubstituted URL for models [ClearML GitHub PR #935](https://github.com/allegroai/clearml/pull/935) +* Fix path substitution, making it possible to store unsubstituted URL for models ([ClearML GitHub PR #935](https://github.com/allegroai/clearml/pull/935)) ### ClearML SDK 1.9.2 **New Features and Improvements** -* Support parsing queue name when providing execution queue in pipelines code [ClearML GitHub PR #857](https://github.com/allegroai/clearml/pull/857) -* Ignore `None` values for keys in the `click` argument parser [ClearML GitHub issue #902](https://github.com/allegroai/clearml/issues/902) -* Improve docstrings for `Task.mark_completed()` and `Task.close()` - ClearML GitHub PRs [#920](https://github.com/allegroai/clearml/pull/920) and [#921](https://github.com/allegroai/clearml/pull/921) +* Support parsing queue name when providing execution queue in pipelines code ([ClearML GitHub PR #857](https://github.com/allegroai/clearml/pull/857)) +* Ignore `None` values for keys in the `click` argument parser ([ClearML GitHub issue #902](https://github.com/allegroai/clearml/issues/902)) +* Improve docstrings for `Task.mark_completed()` and `Task.close()` (ClearML GitHub PRs [#920](https://github.com/allegroai/clearml/pull/920) and [#921](https://github.com/allegroai/clearml/pull/921)) * Add pre/post execution callbacks to pipeline steps through `@PipelineDecorator.component` * Add status-change callback to pipeline steps through `PipelineController.add_step()`, `PipelineController.add_function_step()`, and `@PipelineDecorator.component` **Bug Fixes** -* Fix missing debug samples when reporting using TensorBoard [ClearML GitHub issue #923](https://github.com/allegroai/clearml/issues/923) -* Fix wrong Jupyter API token during repository detection [ClearML GitHub PR #904](https://github.com/allegroai/clearml/pull/904) -* Fix typo in the warning for very large git diffs [ClearML GitHub PR #932](https://github.com/allegroai/clearml/pull/932) +* Fix missing debug samples when reporting using TensorBoard ([ClearML GitHub issue #923](https://github.com/allegroai/clearml/issues/923)) +* Fix wrong Jupyter API token during repository detection ([ClearML GitHub PR #904](https://github.com/allegroai/clearml/pull/904)) +* Fix typo in the warning for very large git diffs ([ClearML GitHub PR #932](https://github.com/allegroai/clearml/pull/932)) * Fix pipelines from tasks don't propagate `parameter_override` values in `PipelineController.add_step()` * Fix folders and files uploaded to S3 and Azure with `StorageManager.upload_file()` receive wrong MIME types * Fix the CSV file preview in Datasets @@ -33,17 +33,17 @@ and `@PipelineDecorator.component` ### ClearML SDK 1.9.1 **New Features and Improvements** -* Add signature version to `boto3` configuration [ClearML GitHub issue #883](https://github.com/allegroai/clearml/issues/883) +* Add signature version to `boto3` configuration ([ClearML GitHub issue #883](https://github.com/allegroai/clearml/issues/883)) * Allow requesting custom token expiration using the `api.auth.req_token_expiration_sec` configuration setting * Add Python 3.11 support **Bug Fixes** -* Fix `UniformParameterRange.to_list` throws error when step size is not defined [ClearML GitHub issue #858](https://github.com/allegroai/clearml/issues/858) -* Fix `StorageManager.list()` does not return size metadata [ClearML GitHub issue #865](https://github.com/allegroai/clearml/issues/865) -* Fix storage with path substitutions [ClearML GitHub issue #825](https://github.com/allegroai/clearml/issues/825) -* Fix extras in ClearML installation prevents clearml from being included in requirements [ClearML GitHub issue #867](https://github.com/allegroai/clearml/issues/867) -* Fix metadata set on an uploaded model object is not accessible [ClearML GitHub issue #890](https://github.com/allegroai/clearml/issues/890) -* Fix Azure storage upload not working [ClearML GitHub issue #868](https://github.com/allegroai/clearml/issues/868) +* Fix `UniformParameterRange.to_list` throws error when step size is not defined ([ClearML GitHub issue #858](https://github.com/allegroai/clearml/issues/858)) +* Fix `StorageManager.list()` does not return size metadata ([ClearML GitHub issue #865](https://github.com/allegroai/clearml/issues/865)) +* Fix storage with path substitutions ([ClearML GitHub issue #825](https://github.com/allegroai/clearml/issues/825)) +* Fix extras in ClearML installation prevents clearml from being included in requirements ([ClearML GitHub issue #867](https://github.com/allegroai/clearml/issues/867)) +* Fix metadata set on an uploaded model object is not accessible ([ClearML GitHub issue #890](https://github.com/allegroai/clearml/issues/890)) +* Fix Azure storage upload not working ([ClearML GitHub issue #868](https://github.com/allegroai/clearml/issues/868)) * Fix `task.connect` list of dicts parsed incorrectly in remote * Fix casting `None` to `int` fails uploads and permission checks * Fix numpy 1.24 support @@ -51,14 +51,14 @@ and `@PipelineDecorator.component` * Fix connecting a dictionary to task sometimes raises an exception * Fix authentication headers are not set on substituted fileserver URLs * Fix `Task.get_project_id()` cannot find hidden projects -* Fix TriggerScheduler docstrings [ClearML GitHub issue #881](https://github.com/allegroai/clearml/issues/881) +* Fix TriggerScheduler docstrings ([ClearML GitHub issue #881](https://github.com/allegroai/clearml/issues/881)) ### ClearML Server 1.9.2 **Bug Fixes** -* Fix "Unable to load image" error in UI experiment debug samples after entering storage credentials [ClearML Web GitHub issue #46](https://github.com/allegroai/clearml-web/issues/46) -* Fix incorrect default project name displayed in UI "Clone Experiment" modal [ClearML Server GitHub issue #171](https://github.com/allegroai/clearml-server/issues/171) +* Fix "Unable to load image" error in UI experiment debug samples after entering storage credentials ([ClearML Web GitHub issue #46](https://github.com/allegroai/clearml-web/issues/46)) +* Fix incorrect default project name displayed in UI "Clone Experiment" modal ([ClearML Server GitHub issue #171](https://github.com/allegroai/clearml-server/issues/171)) * Fix UI experiment debug sample viewer iteration slider not working * Fix UI experiment console log jumps backwards unnecessarily on refresh * Fix UI published report is not expandable @@ -72,7 +72,7 @@ and `@PipelineDecorator.component` * Add in-app markdown guide for UI reports **Bug Fixes** -* Fix can't generate new pipeline runs from UI [ClearML Server GitHub issue #169](https://github.com/allegroai/clearml-server/issues/169) +* Fix can't generate new pipeline runs from UI ([ClearML Server GitHub issue #169](https://github.com/allegroai/clearml-server/issues/169)) * Fix plot legend texts overlap in UI reports * Fix UI embedded plot colors are sometimes obscure * Fix `ctrl z` doesn't undo codeblocks in UI reports @@ -81,10 +81,10 @@ and `@PipelineDecorator.component` ### ClearML SDK 1.9.0 **New Features and Improvements** -* Add `r` prefix to `re.match()` strings [ClearML GitHub issue #834](https://github.com/allegroai/clearml/issues/834) -* Add `path_substitution` to `clearml.conf` example file [ClearML GitHub PR #842](https://github.com/allegroai/clearml/pull/842) -* Clarify `deferred_init` usage in `Task.init()` [ClearML GitHub issue #855](https://github.com/allegroai/clearml/issues/855) -* Add pipeline decorator argument to control docker image [ClearML GitHub issue #856](https://github.com/allegroai/clearml/issues/856) +* Add `r` prefix to `re.match()` strings ([ClearML GitHub issue #834](https://github.com/allegroai/clearml/issues/834)) +* Add `path_substitution` to `clearml.conf` example file ([ClearML GitHub PR #842](https://github.com/allegroai/clearml/pull/842)) +* Clarify `deferred_init` usage in `Task.init()` ([ClearML GitHub issue #855](https://github.com/allegroai/clearml/issues/855)) +* Add pipeline decorator argument to control docker image ([ClearML GitHub issue #856](https://github.com/allegroai/clearml/issues/856)) * Add `StorageManager.set_report_upload_chunk_size()` and `StorageManager.set_report_download_chunk_size()` to set chunk size for upload and download * Add `allow_archived` argument in `Task.get_tasks()` @@ -93,10 +93,10 @@ size for upload and download * Add `delete_from_storage` (default `True`) to `Task.delete_artifacts()` **Bug Fixes** -* Fix jsonargparse and pytorch lightning integration broken for remote execution [ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403) -* Fix error when using `TaskScheduler` with `limit_execution_time` [ClearML GitHub issue #648](https://github.com/allegroai/clearml/issues/648) -* Fix dataset not synced if the changes are only modified files [ClearML GitHub issue #822](https://github.com/allegroai/clearml/issues/822) -* Fix `StorageHelper.delete()` does not respect path substitutions [ClearML GitHub issue #825](https://github.com/allegroai/clearml/issues/825) +* Fix jsonargparse and pytorch lightning integration broken for remote execution ([ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403)) +* Fix error when using `TaskScheduler` with `limit_execution_time` ([ClearML GitHub issue #648](https://github.com/allegroai/clearml/issues/648)) +* Fix dataset not synced if the changes are only modified files ([ClearML GitHub issue #822](https://github.com/allegroai/clearml/issues/822)) +* Fix `StorageHelper.delete()` does not respect path substitutions ([ClearML GitHub issue #825](https://github.com/allegroai/clearml/issues/825)) * Fix can't write more than 2 GB to a file * Fix `StorageManager.get_file_size_bytes()` returns `ClientError` instead of `None` for invalid S3 links * Fix Dataset lineage view is broken with multiple dataset dependencies @@ -107,14 +107,14 @@ size for upload and download ### ClearML Server 1.9.0 **New Features and Improvements** -* New ClearML Reports UI: Create and share rich MarkDown documents supporting embeddable online content [ClearML GitHub issue #839](https://github.com/allegroai/clearml/issues/839) -* Add user option to not show example content in the UI [ClearML GitHub issue #774](https://github.com/allegroai/clearml/issues/774) +* New ClearML Reports UI: Create and share rich MarkDown documents supporting embeddable online content ([ClearML GitHub issue #839](https://github.com/allegroai/clearml/issues/839)) +* Add user option to not show example content in the UI ([ClearML GitHub issue #774](https://github.com/allegroai/clearml/issues/774)) * Add tag filter to UI Pipeline, Dataset, and Hyper-Dataset pages * Extend UI experiment comparison up to 100 experiments * Allow project default output destination S3 URLs to include dots (`.`) and hyphens (`-`) **Bug Fixes** -* Fix long experiment names break UI experiment comparison scalar plot display [ClearML GitHub issue #166](https://github.com/allegroai/clearml-server/issues/166) +* Fix long experiment names break UI experiment comparison scalar plot display ([ClearML GitHub issue #166](https://github.com/allegroai/clearml-server/issues/166)) * Fix plot legend definitions set by SDK don't override UI default settings * Fix comparing experiments with read-only components causes error * Fix UI model link doesn't preserve double spaces, breaking the URI