Skip to content

Document the benchmark configuration CSV - #334

Open
sylvesterkaczmarek wants to merge 1 commit into
ARM-software:mainfrom
sylvesterkaczmarek:docs/current-config-csv-253
Open

Document the benchmark configuration CSV#334
sylvesterkaczmarek wants to merge 1 commit into
ARM-software:mainfrom
sylvesterkaczmarek:docs/current-config-csv-253

Conversation

@sylvesterkaczmarek

Copy link
Copy Markdown

Summary

  • document that benchmark processing requires a manually created currentConfig.csv
  • provide the exact 11-field header and a valid two-line example
  • explain the boolean fields and the platform, core, compiler, and version values
  • correct the claim that CMake generates the file automatically

Context

Both processResult.py and summaryBench.py locate currentConfig.csv beside the result file supplied with -r. The generator was removed because it was not generic enough, but the README still says that CMake creates the file and does not describe its format.

Fixes #253.

Validation

  • git diff --check
  • parsed the documented example with Python's CSV reader and verified that it contains one header row, one data row, and 11 matching fields
  • verified the file lookup in both processResult.py and summaryBench.py

Documentation-only change. No code tests were run.

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.

Testing/processResult.py and missing currentConfig.csv?

1 participant