From e4eca94eaa351451d33333117caf26d9513eea09 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 26 Jan 2025 13:00:56 +0200 Subject: [PATCH 1/4] Add upgrade notes to ClearML Serving 1.1.0 release notes (#1017) --- docs/release_notes/clearml_serving/ver_1_1.md | 30 +++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/release_notes/clearml_serving/ver_1_1.md b/docs/release_notes/clearml_serving/ver_1_1.md index 77617284..6dd598d1 100644 --- a/docs/release_notes/clearml_serving/ver_1_1.md +++ b/docs/release_notes/clearml_serving/ver_1_1.md @@ -5,7 +5,7 @@ title: Version 1.1 ### ClearML Serving 1.1.0 :::warning Backwards Compatibility -This release is not backwards compatible - see notes below on upgrading +This release is not backwards compatible. See `Upgrading from v1.0` note below. ::: **Breaking Changes** @@ -17,4 +17,30 @@ This release is not backwards compatible - see notes below on upgrading * Triton engine support for variable request (matrix) sizes * Triton support, fix `--aux-config` to support more configurations elements * Hugging Face Transformer support -* `Preprocess` class as module \ No newline at end of file +* `Preprocess` class as module (see `Preprocess Class` note below) + +:::note Upgrading from v1.0 +1. Take down the serving containers (docker-compose or k8s) +1. Update the clearml-serving CLI: `pip3 install -U clearml-serving` +1. Re-add a single existing endpoint: `clearml-serving model add ...` (press `yes` when asked). This will upgrade the +clearml-serving session definitions +1. Pull latest serving containers (`docker-compose pull ...` or k8s) +1. Re-spin serving containers (docker-compose or k8s) +::: + +:::note Preprocess Class +You can now add a `Preprocess` class from a module. The entire module folder will be packaged. + +``` +preprocess_folder +├── __init__.py # from .sub.some_file import Preprocess +└── sub + └── some_file.py +``` + +Pass the top-level folder path using `--preprocess`. For example: + +``` +clearml-serving --id model add --preprocess /path/to/preprocess_folder ... +``` +::: \ No newline at end of file From 2d5bb821d68433f654fdc18139a929aaba991c48 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 26 Jan 2025 13:01:19 +0200 Subject: [PATCH 2/4] Update ClearML Server 2.0.0 release notes (#1016) --- docs/release_notes/clearml_server/open_source/ver_2_0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release_notes/clearml_server/open_source/ver_2_0.md b/docs/release_notes/clearml_server/open_source/ver_2_0.md index 61cb4415..a6558899 100644 --- a/docs/release_notes/clearml_server/open_source/ver_2_0.md +++ b/docs/release_notes/clearml_server/open_source/ver_2_0.md @@ -25,6 +25,7 @@ Upgrading to ClearML Server v1.17 from a previous version: **Bug Fixes** * Fix UI Model Endpoint's Number of Requests plot sometimes displays incorrect data +* Fix UI Incorrect project statistics in project page * Fix UI datasets page does not filter according to project when dataset is running * Fix UI task scalar legend does not change colors when smoothing is enabled * Fix queue list in UI Workers and Queues page does not alphabetically sort by queue display name From 86f5043d365237588f4d950dfe7ef4369fc5cea4 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 26 Jan 2025 13:02:01 +0200 Subject: [PATCH 3/4] Add Enterprise Server 3.23.2 release notes (#1015) --- .../clearml_server/enterprise/ver_3_23.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/release_notes/clearml_server/enterprise/ver_3_23.md b/docs/release_notes/clearml_server/enterprise/ver_3_23.md index 3d6ef2b1..96e9272b 100644 --- a/docs/release_notes/clearml_server/enterprise/ver_3_23.md +++ b/docs/release_notes/clearml_server/enterprise/ver_3_23.md @@ -2,6 +2,25 @@ title: Version 3.23 --- + +### Enterprise Server 3.23.2 + +**New Features** +* Add "Block running user's scripts in the browser" UI setting option for added security +* Add configurable display names for UI Queues + +**Bug Fixes** +* Fix debug samples stored in S3 and GS not embedding in UI Reports +* Fix non-admin users can access disabled administrator vaults +* Fix UI administrator vault contents are deleted when vault is saved a second time +* Fix deleting models in UI does not delete them from the file server +* Fix UI Orchestration usage plots and queue metric data does not update in real time +* Fix UI scalar plots data does not refresh +* Fix UI dataset Preview tab does not display dataset contents +* Fix dataset list sometimes disappears in UI Annotation creation modal +* Fix ‘Failed to fetch history' error displayed unnecessarily in UI Orchestration Dashboard +* Add error message when launching multiple UI autoscaler instances with the same worker prefixes + ### Enterprise Server 3.23.1 **Bug Fixes** From 535c9cc0bf9d1f7faebd03367f7d0c6c9a9eb146 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 26 Jan 2025 13:03:40 +0200 Subject: [PATCH 4/4] Small edits (#1014) --- docs/release_notes/clearml_agent/ver_0_16.md | 2 +- docs/release_notes/clearml_agent/ver_0_17.md | 2 +- docs/release_notes/clearml_agent/ver_1_1.md | 2 +- docs/release_notes/clearml_agent/ver_1_9.md | 2 +- docs/release_notes/clearml_server/enterprise/ver_3_20.md | 2 +- docs/release_notes/sdk/open_source/ver_0_17.md | 8 ++++---- docs/release_notes/sdk/open_source/ver_1_0.md | 4 ++-- docs/release_notes/sdk/open_source/ver_1_12.md | 2 +- docs/release_notes/sdk/open_source/ver_1_14.md | 2 +- docs/release_notes/sdk/open_source/ver_1_2.md | 2 +- docs/release_notes/sdk/open_source/ver_1_4.md | 2 +- docs/release_notes/sdk/open_source/ver_1_7.md | 2 +- docs/webapp/settings/webapp_settings_users.md | 2 +- docs/webapp/webapp_project_overview.md | 3 ++- 14 files changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/release_notes/clearml_agent/ver_0_16.md b/docs/release_notes/clearml_agent/ver_0_16.md index c5f5c412..05108d22 100644 --- a/docs/release_notes/clearml_agent/ver_0_16.md +++ b/docs/release_notes/clearml_agent/ver_0_16.md @@ -6,7 +6,7 @@ title: Version 0.16 ::: -### Trains-Agent 0.16.2 +### Trains Agent 0.16.2 **Features** diff --git a/docs/release_notes/clearml_agent/ver_0_17.md b/docs/release_notes/clearml_agent/ver_0_17.md index fb55b388..13e59170 100644 --- a/docs/release_notes/clearml_agent/ver_0_17.md +++ b/docs/release_notes/clearml_agent/ver_0_17.md @@ -2,7 +2,7 @@ title: Version 0.17 --- -## ClearML Agent 0.17.2 +### ClearML Agent 0.17.2 **Features** diff --git a/docs/release_notes/clearml_agent/ver_1_1.md b/docs/release_notes/clearml_agent/ver_1_1.md index e6ef706e..7ba8db17 100644 --- a/docs/release_notes/clearml_agent/ver_1_1.md +++ b/docs/release_notes/clearml_agent/ver_1_1.md @@ -4,7 +4,7 @@ title: Version 1.1 ### ClearML Agent 1.1.2 -**Bug Fixes** +**Bug Fix** - Fix the `six` conflict with the new `pathlib2` version 2.3.7 and up. diff --git a/docs/release_notes/clearml_agent/ver_1_9.md b/docs/release_notes/clearml_agent/ver_1_9.md index 5abf07a0..5132a634 100644 --- a/docs/release_notes/clearml_agent/ver_1_9.md +++ b/docs/release_notes/clearml_agent/ver_1_9.md @@ -32,7 +32,7 @@ those matching these filters to be used when running containers ### ClearML Agent 1.9.1 -**New Features and Improvements** +**New Feature** * Add default pip version support for Python 3.12 ### ClearML Agent 1.9.0 diff --git a/docs/release_notes/clearml_server/enterprise/ver_3_20.md b/docs/release_notes/clearml_server/enterprise/ver_3_20.md index 58cd89f7..b1e0f271 100644 --- a/docs/release_notes/clearml_server/enterprise/ver_3_20.md +++ b/docs/release_notes/clearml_server/enterprise/ver_3_20.md @@ -23,7 +23,7 @@ title: Version 3.20 ### Enterprise Server 3.20.1 -**New Features and Improvements** +**New Feature** * Add support for serving UI from a subpath **Bug Fixes** diff --git a/docs/release_notes/sdk/open_source/ver_0_17.md b/docs/release_notes/sdk/open_source/ver_0_17.md index ec4c63c9..aa23d87e 100644 --- a/docs/release_notes/sdk/open_source/ver_0_17.md +++ b/docs/release_notes/sdk/open_source/ver_0_17.md @@ -2,7 +2,7 @@ title: Version 0.17 --- -## ClearML 0.17.5 +### ClearML 0.17.5 **Features** @@ -135,14 +135,14 @@ title: Version 0.17 ### ClearML 0.17.2 -**Bug Fixes** +**Bug Fix** * Fix broken `clearml-task` CLI. ### ClearML 0.17.1 -**Bug Fixes** +**Bug Fix** * `clearml-task` CLI link fixed. @@ -156,7 +156,7 @@ title: Version 0.17 * Add `clearml-task` CLI for creating (importing) code into **ClearML** (see details). * Add `Task.create`, which supports importing a code / repository into **ClearML**, including remote execution with `clearml-agent`. -**Bug Fixes** +**Bug Fix** * PyJWT v2.0 breaks the interface. diff --git a/docs/release_notes/sdk/open_source/ver_1_0.md b/docs/release_notes/sdk/open_source/ver_1_0.md index 75fca583..2ceee78e 100644 --- a/docs/release_notes/sdk/open_source/ver_1_0.md +++ b/docs/release_notes/sdk/open_source/ver_1_0.md @@ -95,13 +95,13 @@ title: Version 1.0 ### ClearML 1.0.2 -**Bug Fixes** +**Bug Fix** - Fix in rare scenarios process stuck on exit, again :) ### ClearML 1.0.1 -**Bug Fixes** +**Bug Fix** - Fix in rare scenarios process stuck on exit diff --git a/docs/release_notes/sdk/open_source/ver_1_12.md b/docs/release_notes/sdk/open_source/ver_1_12.md index 09351dee..d9aa4224 100644 --- a/docs/release_notes/sdk/open_source/ver_1_12.md +++ b/docs/release_notes/sdk/open_source/ver_1_12.md @@ -20,7 +20,7 @@ the Pipeline DAG at runtime (as opposed to adhering to the existing structure st * 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** +**Bug Fix** * Fix S3 uploads fail with `LazyEvalWrapper` type error ([ClearML GitHub issue #1081](https://github.com/allegroai/clearml/issues/1081)) ### ClearML 1.12.0 diff --git a/docs/release_notes/sdk/open_source/ver_1_14.md b/docs/release_notes/sdk/open_source/ver_1_14.md index e8460815..046eb183 100644 --- a/docs/release_notes/sdk/open_source/ver_1_14.md +++ b/docs/release_notes/sdk/open_source/ver_1_14.md @@ -41,7 +41,7 @@ title: Version 1.14 ### ClearML 1.14.1 -**Bug Fixes** +**Bug Fix** * Fix created pipelines do not appear in the UI pipelines section ### ClearML 1.14.0 diff --git a/docs/release_notes/sdk/open_source/ver_1_2.md b/docs/release_notes/sdk/open_source/ver_1_2.md index 545e701a..7553e757 100644 --- a/docs/release_notes/sdk/open_source/ver_1_2.md +++ b/docs/release_notes/sdk/open_source/ver_1_2.md @@ -4,7 +4,7 @@ title: Version 1.2 ### ClearML 1.2.1 -**Bug Fixes** +**Bug Fix** - Fix HTTP download fails constructing URL ([ClearML GitHub issue #593](https://github.com/allegroai/clearml/issues/593)) diff --git a/docs/release_notes/sdk/open_source/ver_1_4.md b/docs/release_notes/sdk/open_source/ver_1_4.md index 674ed8dd..2d3d95e3 100644 --- a/docs/release_notes/sdk/open_source/ver_1_4.md +++ b/docs/release_notes/sdk/open_source/ver_1_4.md @@ -4,7 +4,7 @@ title: Version 1.4 ### ClearML 1.4.1 -**Bug Fixes** +**Bug Fix** * Fix Process Pool hangs at exit ([ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674)) ### ClearML 1.4.0 diff --git a/docs/release_notes/sdk/open_source/ver_1_7.md b/docs/release_notes/sdk/open_source/ver_1_7.md index 51f8a5db..d1eb260f 100644 --- a/docs/release_notes/sdk/open_source/ver_1_7.md +++ b/docs/release_notes/sdk/open_source/ver_1_7.md @@ -27,7 +27,7 @@ title: Version 1.7 ### ClearML 1.7.1 -**New Features and Improvements** +**New Feature** * Add callback option for pipeline step retry **Bug Fixes** diff --git a/docs/webapp/settings/webapp_settings_users.md b/docs/webapp/settings/webapp_settings_users.md index 215d2eaa..edfdc764 100644 --- a/docs/webapp/settings/webapp_settings_users.md +++ b/docs/webapp/settings/webapp_settings_users.md @@ -169,7 +169,7 @@ The user group table lists all the active user groups. Each row includes a group 1. Click **+ ADD GROUP** 1. In the dialog, add a group name and description 1. Add members to the group. When clicking the input box, a list of workspace members appears, from which group members - can be selected. Filter the list by typing part of the username. To remove a member, Hover over a user's row and click + can be selected. Filter the list by typing part of the username. To remove a member, hover over a user's row and click the Trash can button 1. Click **SAVE** diff --git a/docs/webapp/webapp_project_overview.md b/docs/webapp/webapp_project_overview.md index 2aafed87..b436c1fe 100644 --- a/docs/webapp/webapp_project_overview.md +++ b/docs/webapp/webapp_project_overview.md @@ -47,7 +47,8 @@ value. Click the point to go to the experiment's details page. ## Project Description -Every project has a `description` field. The UI provides a Markdown editor to edit this field. +Every project has a `description` field. The UI provides a Markdown editor to edit this field. For a quick reference for +the MarkDown syntax that can be used, see [Markdown Formatting Quick Guide](webapp_reports.md#markdown-formatting-quick-guide). In the Markdown document, you can write and share reports and add links to ClearML experiments or any network resource such as issue tracker, web repository, etc.