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

Update coverage file in BabelStream case study #51

Merged
merged 1 commit into from
Jul 19, 2024

Conversation

Pennycook
Copy link
Contributor

@Pennycook Pennycook commented Jul 18, 2024

We forgot to update the BabelStream case study when we changed the coverage schema. Running the example as it was gave an error due to schema validation.

This commit is a best-effort attempt to convert the old coverage file into the new format. It is "best-effort" because:

  • The old format did not include filenames, but the new format requires them. Since the case study already uses anonymized platforms and languages, the simplest solution here was to generate names like "file1" and "file2".

  • The old format stored lines as regions containing the number of "real" lines of code in the range (start, end), rather than storing the specific lines of code that were used. However, since all the data was generated by the same version of Code Base Investigator parsing the same files, all the regions line up. The simplest solution therefore was to pretend that the region represented a contiguous run of lines. The information about the number of comments and amount of whitespace in a region is destroyed by this transformation, but it isn't necessary to compute divergence.

Related issues

Closes #50.

Proposed changes

  • Replace outdated coverage.csv with one using coverage strings that conform to 0.3.0 schema.

@Pennycook Pennycook added bug Something isn't working documentation Improvements or additions to documentation labels Jul 18, 2024
@Pennycook Pennycook added this to the 1.0.0 milestone Jul 18, 2024
We forgot to update the BabelStream case study when we changed the coverage
schema. Running the example as it was gave an error due to schema validation.

This commit is a best-effort attempt to convert the old coverage file into the
new format. It is "best-effort" because:

- The old format did not include filenames, but the new format requires them.
  Since the case study already uses anonymized platforms and languages, the
  simplest solution here was to generate names like "file1" and "file2".

- The old format stored lines as regions containing the number of "real" lines
  of code in the range (start, end), rather than storing the specific lines of
  code that were used. However, since all the data was generated by the
  same version of Code Base Investigator parsing the same files, all the
  regions line up. The simplest solution therefore was to pretend that the
  region represented a contiguous run of lines. The information about the
  number of comments and amount of whitespace in a region is destroyed by this
  transformation, but it isn't necessary to compute divergence.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook Pennycook force-pushed the update-babelstream-coverage branch from 452cc26 to f737bfb Compare July 18, 2024 18:48
@Pennycook Pennycook merged commit c8058fa into intel:main Jul 19, 2024
3 checks passed
@Pennycook Pennycook deleted the update-babelstream-coverage branch July 19, 2024 19:09
Pennycook added a commit that referenced this pull request Oct 18, 2024
- Switches to furo theme (#47)
- Updates examples to new style (#51, #67)
- Adds new examples (#54, #55, #58)
- Marks the documentation unstable (#72)

Signed-off-by: John Pennycook <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BabelStream NavChart case-study uses wrong coverage format
2 participants