Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update aggregate command reference with latest changes #8823

Merged
merged 3 commits into from
Dec 3, 2024
+22 −1
Merged

update aggregate command reference with latest changes #8823

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bcc481
update aggregate command reference with latest changes
OVI3D0 Nov 27, 2024
289f247
Update aggregate.md
Naarcha-AWS Dec 3, 2024
bcf09ab
Merge branch 'main' into main
Naarcha-AWS Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion _benchmark/reference/commands/aggregate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,30 @@
-------------------------------
```

The results will be aggregated into one test execution and stored under the ID shown in the output:
The results will be aggregated into one test execution and stored under the ID shown in the output.

### Additional options
- `--test-execution-id`: Define a unique ID for the aggregated test execution.
- `--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 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:

```json
"throughput": {
"overall_min": 29056.890292903263,
"mean": 50115.8603858536,
"median": 50099.54349684457,
"overall_max": 72255.15946248993,
"unit": "docs/s",
"mean_rsd": 59.426059705973664
},
```
Loading