Skip to content

README.md

Latest commit

 

History

History
35 lines (25 loc) · 1.63 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.63 KB

Documentation

The docs/ directory contains the workflow and reproducibility notes that sit above the short per-directory README files.

Recommended Reading Order

  1. artifact_quickstart.md: fastest path from clone to correctness, benchmark, and roofline outputs
  2. artifact_checklist.md: pre-release and pre-submission checklist
  3. repo_structure.md: directory map and file placement guide
  4. repo_guide.md: repository ownership and the src/ versus ara/ model
  5. benchmark_workflow.md: benchmark methodology, output contract, and log interpretation

Document Map

File Purpose
artifact_quickstart.md reader-facing quick start for artifact reproduction
artifact_checklist.md release and submission checklist for artifact hygiene
repo_structure.md directory tree, source placement, and navigation map
repo_guide.md repository mental model and ownership boundaries
benchmark_workflow.md benchmark campaign workflow and reporting contract

When To Read docs/

Use this directory when you need:

  • a reproduction-oriented workflow rather than a directory summary
  • guidance on how to launch and interpret benchmark campaigns
  • a clear explanation of which tree is the BitFly source of truth

For directory-level navigation, return to: