Skip to content

Lead the README from the maintained cases to the committed reports - #7

Merged
shinaoka merged 1 commit into
mainfrom
readme-results-path
Oct 10, 2026
Merged

shinaoka merged 1 commit into
mainfrom
readme-results-path

Conversation

@shinaoka

Copy link
Copy Markdown
Member

The README had no path to a single number: a reader had to know to browse
result/<profile>/report.md. This adds that path.

  • The README opens with a Results section: a table linking every committed
    profile's report.md, with the machine, thread count and measured
    tensor4all-rs revision in the same row, plus a pointer to result/README.md.
  • result/README.md describes one profile directory (run.yaml, raw/,
    report.md), says which artifact is generated, and states that a -<n>t
    profile is read against that machine's single-core profile rather than
    instead of it.

Modeled on tprims-benchmark, whose README is a navigation page over its
result tree. Documentation only; no code or record changes.

Validation: git diff --check, cargo fmt --all -- --check,
cargo clippy --locked --all-targets -- -D warnings,
cargo test --release --locked (22 passed).

@shinaoka
shinaoka merged commit c246098 into main Oct 10, 2026
1 check passed
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.

1 participant