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.

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

Extension of the metric reported by the benchmark runner #12

Merged

Conversation

constraintAutomaton
Copy link
Member

Main changes

This PR adds new metrics to the benchmark runner for better statistical analysis. There are two major changes.

The first one is that for the timestamps, time, and number of HTTP requests, the standard deviation is reported. This change is not configurable. The standard deviation was not added to the result field, but I do not expect it to be used. I believe that when it comes to results, the user would want to know if they are the same or not and do not want to do more analysis on it.

The second is an option via the outputRawResults parameter in ISparqlBenchmarkRunnerArgs to generate in the output the raw data. I only implemented it for the time being because I expected it to be the only measurement where a user would want to do a more extensive statistical analysis, such as statistical significance and analysis of the distribution of the results. This field is optional and generates a new IAggregateResult with the extra information. I opted not to generate a separate file so that I do not change the current interface of the runner.

Minor changes

Some light documentation has been added.

@coveralls
Copy link

coveralls commented Sep 25, 2024

Pull Request Test Coverage Report for Build 11065473974

Details

  • 23 of 23 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 10959329793: 0.0%
Covered Lines: 272
Relevant Lines: 272

💛 - Coveralls

Copy link
Member

@rubensworks rubensworks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also document these changes in the README?

test/SparqlBenchmarkRunner-test.ts Outdated Show resolved Hide resolved
@rubensworks
Copy link
Member

@surilindur could you also have a look?

@surilindur
Copy link
Contributor

I am not sure I understand what the 'raw aggregate result' means or how it differs from the aggregated results or the raw results, but if it works then I think it is great. 🙂 The changes do not seem to modify a lot of existing things.

@constraintAutomaton
Copy link
Member Author

I am not sure I understand what the 'raw aggregate result' means or how it differs from the aggregated results or the raw results, but if it works then I think it is great. 🙂 The changes do not seem to modify a lot of existing things.

It just add all the time measurement with the aggregate results. Perhaps, I could find a better name.

lib/ResultAggregator.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
bin/sparql-benchmark-runner.ts Outdated Show resolved Hide resolved
test/SparqlBenchmarkRunner-test.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
…egateResult, and optional iteration results made mandatory.
…aton/sparql-benchmark-runner.js into feature/extended_results
@rubensworks rubensworks merged commit c11a13f into comunica:master Sep 27, 2024
7 checks passed
@rubensworks
Copy link
Member

Great! Released as 4.3.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants