Skip to content

Commit

Permalink
Update aggregate.md
Browse files Browse the repository at this point in the history
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS authored Dec 3, 2024
1 parent 2bcc481 commit 289f247
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions _benchmark/reference/commands/aggregate.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,16 @@ The results will be aggregated into one test execution and stored under the ID s
- `--results-file`: Write the aggregated results to the provided file.
- `--workload-repository`: Define the repository from which OpenSearch Benchmark will load workloads (default is `default`).

## Aggregated Results
Aggregated results now include new metrics and changes:
## Aggregated results

- **Relative Standard Deviation (RSD)**: For each metric (e.g., throughput, latency, service time) an additional `mean_rsd` value is included to show the spread of results across test executions.
- **Overall Min/Max Values**: Instead of averaging min and max values, the aggregated results now include `overall_min` and `overall_max` which reflect the true minimum/maximum across all test executions.
- **Storage**: Aggregated test results are now stored in a separate `aggregated_results` folder alongside the `test_executions` folder.
Aggregated results includes the following information:

- **Relative Standard Deviation (RSD)**: For each metric an additional `mean_rsd` value shows the spread of results across test executions.
- **Overall min/max values**: Instead of averaging minimum and maximum values, the aggregated result include `overall_min` and `overall_max` which reflect the true minimum/maximum across all test runs.
- **Storage**: Aggregated test results are stored in a separate `aggregated_results` folder alongside the `test_executions` folder.

Check failure on line 85 in _benchmark/reference/commands/aggregate.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.SpacingWords] There should be one space between words in 'are stored'. Raw Output: {"message": "[OpenSearch.SpacingWords] There should be one space between words in 'are stored'.", "location": {"path": "_benchmark/reference/commands/aggregate.md", "range": {"start": {"line": 85, "column": 40}}}, "severity": "ERROR"}

The following example shows aggregated results:

### Aggregated Metrics Example:
```json
"throughput": {
"overall_min": 29056.890292903263,
Expand All @@ -93,4 +95,4 @@ Aggregated results now include new metrics and changes:
"unit": "docs/s",
"mean_rsd": 59.426059705973664
},
```
```

0 comments on commit 289f247

Please sign in to comment.