ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-23 05:24:38 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add ClearML Serving 1.1 release notes (#323)

Browse Source
This commit is contained in:
pollfly 2022-09-06 10:23:42 +03:00 committed by GitHub
parent 61b9b482f8
commit c85bfeeb94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/clearml_serving/clearml_serving.md
View File

@ -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

3
docs/clearml_serving/clearml_serving_cli.md
View File

@ -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}
```
<div className="tbl-cmd">
@ -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) | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|`--debug` | Print debug messages | <img src="/docs/latest/icons/ico-optional-yes.svg" alt="Yes" className="icon size-md center-md" /> |
|`--yes` |Always answer YES on interactive inputs| <img src="/docs/latest/icons/ico-optional-yes.svg" alt="Yes" className="icon size-md center-md" /> |
</div>

43
docs/release_notes/ver_1_1.md
View File

@ -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 <serving_session_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**