Add docs API diagrams and site updates#159
Conversation
|
| Filename | Overview |
|---|---|
| docs/images/packet_diagrams/anim_common.py | New shared utility module providing font loading with multi-platform fallbacks, a unified font scheme, and atomic animated WebP export via a temp-file rename pattern. |
| docs/images/packet_diagrams/incoming_wire.py | New shared RX wire rendering module; draws three parallel wire traces and optional in-flight packet markers. Wave animation is implemented but disabled by default (wave=False) in all current callers. |
| docs/images/packet_diagrams/flow_steering_animation.py | New animated WebP generator for flow steering concept; draws packets routed from NIC to per-flow GPU queues or the kernel fallback path across multiple themes. |
| docs/images/packet_diagrams/hds_animation.py | New animated WebP generator for header-data split; renders split header/payload paths to host and GPU memory with Bezier and rectangular path interpolation. |
| docs/images/packet_diagrams/Makefile | New build target wiring up the three animation generators plus a reproducibility check via git-status diff of generated directories. |
| mkdocs.yml | Excludes docs/images/packet_diagrams/README.md from the docs site build so the developer-facing regeneration instructions don't appear as a public page. |
| .gitignore | Adds a duplicate pycache/ entry; the pattern already exists on line 12 of the file. |
| docs/images/packet_diagrams/README.md | New developer README documenting requirements (Pillow 11.1.x with webp_anim), regeneration commands, and notes on WebP frame coalescing behavior. |
Reviews (6): Last reviewed commit: "#159 - Replace packet-diagram GIFs with ..." | Re-trigger Greptile
02cfa96 to
7e6940f
Compare
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Signed-off-by: dleshchev <dleshchev@nvidia.com>
Add Pillow GIF generators for header-data split, flow steering, and GPU reorder. Share RX wire rendering via incoming_wire.py (wavy lines, labeled in-flight packets, dark/light themes). Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
7e6940f to
4a3a6bc
Compare
…antize Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
…antize Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
166d912 to
e161ca5
Compare
Transparent canvas, unified dark-blue panels, darker route lines, flow-steering three-path layout, and GIF export alongside WebP. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
Match staging/slot column widths and drop overlapping convert label. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
Single-theme transparent diagrams for slides, shared incoming-wire rendering, gitignored WebP/GIF with CI generation, and updated docs embeds. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
Single-theme transparent diagrams for slides, shared incoming-wire rendering, gitignored WebP/GIF with CI generation, and updated docs embeds. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
Single-theme transparent diagrams for slides, shared incoming-wire rendering, gitignored WebP/GIF with CI generation, and updated docs embeds. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
Summary
incoming_wire.py(wavy lines, labeled in-flight packets)Examples
HDS
Flow Steering
Packet Reordering
Packet Reordering (Quantized)
Test plan
docs/images/packet_diagrams/{hds,flow_steering,reorder}/python3 docs/images/packet_diagrams/*_animation.pymkdocs serveand spot-check docs pages