Files
kernbench2/docs/diagrams
mukesh 1e39214f89 Move generated diagrams to docs/diagrams/; add IPCQ diagram emitter
Plot output dirs now live under docs/diagrams/ (the canonical
"derived artifacts" location per CLAUDE.md):
  tests/allreduce_latency_plots/ → docs/diagrams/allreduce_latency_plots/
  tests/pe2pe_latency_plots/     → docs/diagrams/pe2pe_latency_plots/
  + new docs/diagrams/ipcq_diagram_plots/ with two presentation diagrams
    (ipcq_send_recv.png, ipcq_two_pe_dma.png)

New test tests/test_emit_ipcq_diagram.py renders the two IPCQ
diagrams from a static description (no simulation); it exists so
the diagrams can be regenerated reproducibly.

Path references updated in tests/test_pe_to_pe_latency.py.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-27 21:28:17 -07:00
..
2026-03-18 11:47:48 -07:00
2026-03-18 11:47:48 -07:00
2026-03-18 11:47:48 -07:00
2026-03-18 11:47:48 -07:00

Generated Diagrams

This directory contains diagrams generated from topology compilation.

What these files are

  • Derived artifacts generated from:
    • compiled topology graph
    • distance (accumulated latency) metadata
    • view/layout rules (ADR-0005)

These files are meant for quick visual inspection and review.

Default outputs

  • SIP view: sip_view.mmd (and/or sip_view.dot)
  • CUBE view: cube_view.mmd (and/or cube_view.dot)
  • PE view: pe_view.mmd (and/or pe_view.dot)

How to preview

  • In VS Code:
    • open .mmd or .md containing Mermaid blocks and use Markdown Preview
    • for .dot, use a Graphviz preview extension or dot -Tpng

Notes

  • Diagrams are representative and distance-aware by default.
  • Instance indices are not required unless debugging asymmetry.
  • Outputs should be deterministic for the same topology and rules.