From 36c8cd6f1fb031b385292b0d7b46718213c36d4e Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Wed, 20 Sep 2023 15:58:06 +0000 Subject: [PATCH 1/2] metrics: Fix metrics README This PR fixes the network metrics section at the README by leaving the current tests that we have in our kata metrics. Fixes #8017 Signed-off-by: Gabriela Cervantes --- tests/metrics/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/metrics/README.md b/tests/metrics/README.md index ab55e10528..68d6d535d2 100644 --- a/tests/metrics/README.md +++ b/tests/metrics/README.md @@ -62,7 +62,6 @@ Tests relating to networking. General items could include: - latency - jitter - parallel bandwidth -- write and read percentiles For further details see the [network tests documentation](network). From 97e73b22344ab15158080d1078d8c8a78ddc9f78 Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Fri, 22 Sep 2023 15:40:27 +0000 Subject: [PATCH 2/2] metrics: Fix spelling warnings This PR fixes general spelling warnings detected by the spelling check. Signed-off-by: Gabriela Cervantes --- tests/metrics/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tests/metrics/README.md b/tests/metrics/README.md index 68d6d535d2..56af313187 100644 --- a/tests/metrics/README.md +++ b/tests/metrics/README.md @@ -33,7 +33,7 @@ regression checking, we try to define and stick to some "quality measures" for o ## Categories -Kata Container metrics tend to fall into a set of categories, and we organise the tests +Kata Container metrics tend to fall into a set of categories, and we organize the tests within this folder as such. Each sub-folder contains its own `README` detailing its own tests. @@ -60,7 +60,7 @@ For further details see the [density tests documentation](density). Tests relating to networking. General items could include: - bandwidth - latency -- jitter +- `jitter` - parallel bandwidth For further details see the [network tests documentation](network). @@ -80,7 +80,7 @@ For further details see the [disk tests documentation](disk). ### Machine Learning Tests relating with TensorFlow and Pytorch implementations of several popular -convolutional models. +`convolutional` models. For further details see the [machine learning tests documentation](machine_learning). @@ -113,7 +113,7 @@ to do some JSON handling themselves before injecting their JSON into the API. #### `metrics_json_init()` -Initialise the API. Must be called before all other JSON API calls. +Initialize the API. Must be called before all other JSON API calls. Should be matched by a final call to `metrics_json_save`. Relies upon the `TEST_NAME` variable to derive the file name the final JSON @@ -147,7 +147,7 @@ Add a JSON formatted fragment at the top level. #### `metrics_json_start_array()` -Initialise the JSON array API subsystem, ready to accept JSON fragments via +Initialize the JSON array API subsystem, ready to accept JSON fragments via `metrics_json_add_array_element`. This JSON array API subset allows accumulation of multiple entries into a