diff --git a/docs/clearml_serving/clearml_serving.md b/docs/clearml_serving/clearml_serving.md index 00fef1f7..1b8488e9 100644 --- a/docs/clearml_serving/clearml_serving.md +++ b/docs/clearml_serving/clearml_serving.md @@ -60,6 +60,11 @@ solution. * **Dashboards** - Customizable dashboard solution on top of the collected statistics, e.g. Grafana ## Installation + +:::important Upgrading ClearML Serving +To upgrade to ClearML Serving version 1.1, see instructions [here](../release_notes/ver_1_1.md#clearml-serving-110). +::: + ### Prerequisites * ClearML-Server : Model repository, Service Health, Control plane diff --git a/docs/clearml_serving/clearml_serving_cli.md b/docs/clearml_serving/clearml_serving_cli.md index fc729a6d..ee2a30d1 100644 --- a/docs/clearml_serving/clearml_serving_cli.md +++ b/docs/clearml_serving/clearml_serving_cli.md @@ -14,7 +14,7 @@ The following page provides a reference for `clearml-serving`'s CLI commands: ## Global Parameters ```bash -clearml-serving [-h] [--debug] [--id ID] {list,create,metrics,config,model} +clearml-serving [-h] [--debug] [--yes] [--id ID] {list,create,metrics,config,model} ```
@@ -23,6 +23,7 @@ clearml-serving [-h] [--debug] [--id ID] {list,create,metrics,config,model} |---|---|---| |`--id`|Serving Service (Control plane) Task ID to configure (if not provided automatically detect the running control plane Task) | No | |`--debug` | Print debug messages | Yes | +|`--yes` |Always answer YES on interactive inputs| Yes |
diff --git a/docs/release_notes/ver_1_1.md b/docs/release_notes/ver_1_1.md index 00ffe414..ade50fc1 100644 --- a/docs/release_notes/ver_1_1.md +++ b/docs/release_notes/ver_1_1.md @@ -2,6 +2,49 @@ title: Version 1.1 --- +### ClearML Serving 1.1.0 + +:::warning Backwards Compatibility +This release is not backwards compatible - see notes below on upgrading +::: + +**Breaking Changes** +* Triton engine size supports variable request size (-1) + +**Features & Bug Fixes** + +* Add version number of serving session task +* Triton engine support for variable request (matrix) sizes +* Triton support, fix `--aux-config` to support more configurations elements +* Huggingface Transformer support +* `Preprocess` class as module (see note below) + +:::important Preprocess Class +To 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 folder as a path for --preprocess, for example: + +```bash +clearml-serving module --id add --preprocess /path/to/preprocess_folder ... +``` +::: + +**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 with `clearml-serving module add ... ` (press yes when asked). It will upgrade the + `clearml-serving` session definitions +1. Pull the latest serving containers (`docker-compose pull ...` or k8s) +1. Re-spin serving containers (`docker-compose` or k8s) + + ### ClearML Agent 1.1.2 **Bug Fixes**