diff --git a/docs/clearml_serving/clearml_serving_cli.md b/docs/clearml_serving/clearml_serving_cli.md index ee2a30d1..a91ef2dc 100644 --- a/docs/clearml_serving/clearml_serving_cli.md +++ b/docs/clearml_serving/clearml_serving_cli.md @@ -85,7 +85,7 @@ clearml-serving metrics add [-h] --endpoint ENDPOINT [--log-freq LOG_FREQ] |---|---|---| |`--endpoint`|Metric endpoint name including version (e.g. `"model/1"` or a prefix `"model/*"`). Notice: it will override any previous endpoint logged metrics| No| |`--log-freq`|Logging request frequency, between 0.0 to 1.0. Example: 1.0 means all requests are logged, 0.5 means half of the requests are logged if not specified. To use global logging frequency, see [`config --metric-log-freq`](#config)| Yes| -|`--variable-scalar`|Add float (scalar) argument to the metric logger, `=`. Example: with specific buckets: `"x1=0,0.2,0.4,0.6,0.8,1"` or with min/max/num_buckets `"x1=0.0/1.0/5"` | Yes| +|`--variable-scalar`|Add float (scalar) argument to the metric logger, `=`. Example: with specific buckets: `"x1=0,0.2,0.4,0.6,0.8,1"` or with min/max/num_buckets `"x1=0.0/1.0/5"`. Notice: In cases where 1000s of requests per second reach the serving, it makes no sense to display every datapoint. So scalars can be divided in buckets, and for each minute for example. Then its possible to calculate how many % of the total traffic fell in bucket 1, bucket 2, bucket 3 etc. The Y axis represents the buckets, color is the value in % of traffic in that bucket, and X is time. | Yes| |`--variable-enum`|Add enum (string) argument to the metric logger, `=`. Example: `"detect=cat,dog,sheep"` |Yes| |`--variable-value`|Add non-samples scalar argument to the metric logger, ``. Example: `"latency"` |Yes|