github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-05-09 08:57:25 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8018 from GabyCT/topic/fixreadme

Browse Source 
metrics: Fix metrics README
This commit is contained in:
GabyCT 2023-09-26 09:51:47 -06:00 committed by GitHub
commit 5c0afaacf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tests/metrics/README.md
View File

@ -33,7 +33,7 @@ regression checking, we try to define and stick to some "quality measures" for o
## Categories ## 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. within this folder as such.
Each sub-folder contains its own `README` detailing its own tests. Each sub-folder contains its own `README` detailing its own tests.
@ -60,9 +60,8 @@ For further details see the [density tests documentation](density).
Tests relating to networking. General items could include: Tests relating to networking. General items could include:
- bandwidth - bandwidth
- latency - latency
- jitter - `jitter`
- parallel bandwidth - parallel bandwidth
- write and read percentiles
For further details see the [network tests documentation](network). For further details see the [network tests documentation](network).
@ -81,7 +80,7 @@ For further details see the [disk tests documentation](disk).
### Machine Learning ### Machine Learning
Tests relating with TensorFlow and Pytorch implementations of several popular 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). For further details see the [machine learning tests documentation](machine_learning).
@ -114,7 +113,7 @@ to do some JSON handling themselves before injecting their JSON into the API.
#### `metrics_json_init()` #### `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`. 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 Relies upon the `TEST_NAME` variable to derive the file name the final JSON
@ -148,7 +147,7 @@ Add a JSON formatted fragment at the top level.
#### `metrics_json_start_array()` #### `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`. `metrics_json_add_array_element`.
This JSON array API subset allows accumulation of multiple entries into a This JSON array API subset allows accumulation of multiple entries into a