clearml-docs/docs/release_notes/sdk/open_source/ver_0_17.md

163 lines
8.2 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: Version 0.17
---
2025-01-26 11:03:40 +00:00
### ClearML 0.17.5
2021-05-13 23:48:51 +00:00
**Features**
- Add `force_download` argument to `Artifact.get()` and `Artifact.get_local_copy()` ([clearml GitHub Issue 319](https://github.com/allegroai/clearml/issues/319)).
- Support all reporting using subprocesses instead of threads (default `sdk.development.report_use_subprocess=True`).
- Improve Datasets support:
* Add `clearml-data publish` to allow publishing a dataset task.
* Add `clearml-data sync`, which can now create, sync and close a dataset with a single command.
* Allow Dataset to be created on a running Task.
* Add `dataset_tags` argument to `Dataset.get()`.
* Add `Dataset.get_logger()`.
- Add `Task.add_requirements()` support for specifying version `<>=~` etc.
- Add `StorageManager.upload_folder()` and `StorageManager.download_folder()`.
- Add progress report logging for `StorageHelper.upload_from_stream()`, `StorageHelper.upload()` and `StorageHelper.upload_from_stream()`.
- Add jupyter auto-magic - store Jupyter Notebook as an artifact on the Task (default `sdk.development.store_jupyter_notebook_artifact=True`).
- Add upload HTML preview of Jupyter Notebook as an artifact.
- Add `PipelineController` disable clone base task option.
- Add links to Tasks in optimization summary table (not just Task IDs).
- Add support for datetime in scatter plots + matplotlib support.
- Improve plotly value type conforming.
- Improve PyTorch `DataLoader` speed ([clearml GitHub Issue 207](https://github.com/allegroai/clearml/issues/207)).
- Update Auto Scaler default values and configuration.
- Examples:
* Add Hydra example.
* Add artifacts retrieval example.
* Update various examples.
**Bug Fixes**
- Fix warning or error message if requirements parsing failed ([clearml GitHub Issue 291](https://github.com/allegroai/clearml/issues/291)).
- Fix pytorch-lighting multi node store ([clearml GitHub Issue 292](https://github.com/allegroai/clearml/issues/292)).
- Fix strip remote diff ([clearml GitHub Issue 295](https://github.com/allegroai/clearml/issues/295)).
- Fix Python package detection `sklearn` -> `scikit-learn` ([clearml GitHub Issue 296](https://github.com/allegroai/clearml/issues/296)).
- Fix argparse issues:
* Fix argparse with `[None]` in default parameter ([clearml GitHub Issue 297](https://github.com/allegroai/clearml/issues/297)).
* Fix parsing of arguments in scientific notation ([clearml GitHub Issue 313](https://github.com/allegroai/clearml/issues/313)).
* Fix argparser logging always captures defaults (Windows only, ignored cmd).
* Fix argparse `nargs` passed in command line `--nargs 1 2` should be stored as `[1, 2]` not as `['1', '2']`.
* Fix support for nonstandard argparse with default value that is not of defined type.
* Fix server updated with the argparse in remote before Task.init() is called (respect skipped args).
- Fix Dataset support:
* Fix `Dataset.remove_files()` can't find files when files are in dataset root ([clearml GitHub Issue 303](https://github.com/allegroai/clearml/issues/303)).
* Fix closing a dataset with only files removed.
* Fix Dataset generate removed / modified / added of summary table.
- Fix Hydra multi-run support ([clearml GitHub Issue 306](https://github.com/allegroai/clearml/issues/306)).
- Fix TF/TensorBoard support:
* Fix TensorBoard multiple `Task.init()` / `Task.close()` calls within the same process ([clearml GitHub Issue 312](https://github.com/allegroai/clearml/issues/312)).
* Fix TensorBoard 2+ `pr_curve`.
* Fix TF `pr_curve` should not be inverted.
* Fix TF +2.3 mixed eager mode execution summary metrics not reported.
* Fix TF bind keyboard interrupt.
* Fix TF 2.4 keras load / save model.
- Fix `clearml-task`:
* Fix error when script cannot be found.
* Fix `--docker` flag not passed.
* Fix patching local git diff.
- Fix `clearml-data`:
* Fix `clearml-data sync` requires `--name`.
* Fix missing required argument `--files` in `clearml-data remove`.
- Fix `Task.execute_remotely()` from Jupyter Notebook.
- Fix populate Task called from Jupyter Notebook (use `Task.create(packages=True)` to auto populate based on locally installed packages).
- Fix plotly plot with numpy containing `NaN` / `datetime`.
- Fix matplotlib with Agg backend (or in remote execution).
- Fix trying to upload model file as a folder (automatically package the folder).
- Fix broken packages on package `importlib` detection failed the entire requirements detection.
- Fix `Task.connect(object)` should always return the same object instance.
- Fix `Task.create()` with repo and script that exists locally.
- Fix crash in case `Logger.get_logger()` cannot get the file name.
- Fix exception at exit in Python 3.8+ on macOS / Windows.
- Fix make pipeline summary table link to Task step logs.
- Fix Hydra 1.1 support (argparse description).
- Fix close task after logger is closed.
- Fix `Task.set_base_docker()` in remote execution.
- Fix artifact preview limit to 64Kb.
- Fix JupyterLab Notebook detection.
- Fix Python 2.7 support.
2024-09-26 13:09:25 +00:00
### ClearML 0.17.4
2021-05-13 23:48:51 +00:00
**Features**
- Add `HyperParameterOptimizer` parallel coordinates ([clearml GitHub Issue 279](https://github.com/allegroai/trains/issues/279)).
- Add `Task.init()` argument `tags`.
- Change HPO parallel coordinates color scale, yellow is low.
- Change `HyperParameterOptimizer` `spawn_task_project` to `spawn_project`.
- Revert all Numpy requirement changes, use only lower limit.
**Bug Fixes**
- Fix argparse `nargs` support.
- Fix argparse with `action="append"`.
- Fix PyJWT v2.0 token parsing.
- Fix Python package detection it should not list `file://` links.
2024-09-26 13:09:25 +00:00
### ClearML 0.17.3
2021-05-13 23:48:51 +00:00
**Features**
* Add `Task.delete()` support.
* Add `Task.debug_simulate_remote_task()` to simulate task execution by ClearML Agent.
* Add warning on archived Task in pipeline ([clearml GitHub Issue 274](https://github.com/allegroai/trains/issues/274)).
* Add `Task.init(..., output_uri=True)`, which will use the default files_server as output uri.
* Make `clearml-data` CLI stateful, so it remembers last dataset ID as default dataset.
* Added `HyperParameterOptimizer.get_optimizer_top_experiments()` for querying post execution optimization pipeline.
* Add `Task.set_archived()` and `Task.get_archived()`.
* Add `Task.set_credentials()` option to store into credentials file.
* Add `clearml-data` close now auto uploads.
* Add `HyperParameterOptimizer` arguments `spawn_task_project` and `save_top_k_tasks_only`.
**Bug Fixes**
* Fix PipelineController running remotely without configuration does not execute the default code pipeline ([clearml GitHub Issue 273](https://github.com/allegroai/trains/issues/273)).
* Fix reusing task after its project was deleted ([clearml GitHub Issue 274](https://github.com/allegroai/trains/issues/274)).
* Fix `Task.archived_tag read-only` property does not work ([clearml GitHub Issue 274](https://github.com/allegroai/trains/issues/274)).
* Fix argparse support to store consistent str representation of custom objects. Avoid changing default value if remote value matches.
* Fix argparse type as function.
* Fix Dataset add single and multiple file(s).
* Fix get project name from parent dataset if not specified.
* Fix mpl exporter. Added support for legend.
* Fix model upload.
* Fix optimizer callback best experiment.
* Fix Optuna optimizer failing on tasks with None value in scalar query.
* Fix auto Python package detection installed directly from URLs.
* Fix dataset upload aborted on server watchdog.
* Fix dataset genealogy, graph and restoring data.
* Fix numpy dependency for Python versions.
2024-09-26 13:09:25 +00:00
### ClearML 0.17.2
2021-05-13 23:48:51 +00:00
2025-01-26 11:03:40 +00:00
**Bug Fix**
2021-05-13 23:48:51 +00:00
* Fix broken `clearml-task` CLI.
2024-09-26 13:09:25 +00:00
### ClearML 0.17.1
2021-05-13 23:48:51 +00:00
2025-01-26 11:03:40 +00:00
**Bug Fix**
2021-05-13 23:48:51 +00:00
* `clearml-task` CLI link fixed.
2024-09-26 13:09:25 +00:00
### ClearML 0.17.0
2021-05-13 23:48:51 +00:00
**Features**
* Renamed `trains` as `clearml` (see [clearml](https://github.com/allegroai/clearml) in GitHub).
* Add `clearml-data` CLI for Differential Dataset Management & Versioning (see <a href="https://github.com/allegroai/clearml/blob/master/docs/datasets.md">details</a>).
* Add `clearml-task` CLI for creating (importing) code into **ClearML** (see <a href="https://github.com/allegroai/clearml/blob/master/docs/clearml-task.md">details</a>).
* Add `Task.create`, which supports importing a code / repository into **ClearML**, including remote execution with `clearml-agent`.
2025-01-26 11:03:40 +00:00
**Bug Fix**
2021-05-13 23:48:51 +00:00
* PyJWT v2.0 breaks the interface.