Skip to content

[REPORT] Add student-facing example report templates#792

Closed
allnes wants to merge 2 commits into
learning-process:masterfrom
allnes:an/template-reports
Closed

[REPORT] Add student-facing example report templates#792
allnes wants to merge 2 commits into
learning-process:masterfrom
allnes:an/template-reports

Conversation

@allnes
Copy link
Copy Markdown
Member

@allnes allnes commented Jun 4, 2026

What changed

  • Converted the existing tasks/example report tree into student-facing report templates.
  • Added root guidance for the report tree, shared files, implementation sections, formulas, appendix, and filling rules.
  • Added thread-semester report sections for problem statement, algorithm description, build/run instructions, correctness verification, experiment setup, performance results, analysis, and conclusion.
  • Added process-semester report sections for T1, T2, and T3 with separate sequential and MPI baselines.
  • Added implementation-specific report templates for sequential, MPI, OpenMP, oneTBB, STL/std::thread, and combined implementations.
  • Kept all changes inside existing Markdown files under tasks/example.

@allnes allnes marked this pull request as ready for review June 4, 2026 17:23
@allnes allnes requested a review from aobolensk as a code owner June 4, 2026 17:23
@allnes allnes changed the title Add student-facing example report templates [REPORT] Add student-facing example report templates Jun 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.42%. Comparing base (b5700c2) to head (fd86a9f).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #792   +/-   ##
=======================================
  Coverage   92.42%   92.42%           
=======================================
  Files          15       15           
  Lines         515      515           
  Branches      199      199           
=======================================
  Hits          476      476           
  Misses          4        4           
  Partials       35       35           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Fill in this report with the MPI implementation for process task T1. Compare it only with
`../seq/report.md`.

- Source files: `<T1 MPI source files>`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does report really need to be that verbose in general? And I still not fully get the multilayer structure of the report itself. Is that really needed?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Does report really need to be that verbose in general? And I still not fully get the multilayer structure of the report itself. Is that really needed?

I ran a few experiments to understand where the agent tends to get stuck, and this structure is based on those results.

If you think it is too heavy or excessive, we can discuss it separately.

But in any case, the agents are already generating this content, so the template is intentionally designed to make the report a bit more demanding and force a more careful output.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

And I have a plan convert it to pdf
example-report-template.pdf

@allnes allnes requested a review from aobolensk June 4, 2026 22:27
@allnes allnes closed this Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants