Skip to content

Update README with GPU acceleration and v2.0.0 docs - #20

Merged
joeljose merged 1 commit into
mainfrom
docs/update-readme-gpu-v2
Mar 21, 2026
Merged

Update README with GPU acceleration and v2.0.0 docs#20
joeljose merged 1 commit into
mainfrom
docs/update-readme-gpu-v2

Conversation

@joeljose

Copy link
Copy Markdown
Owner

Summary

  • Added GPU Acceleration section documenting two-pass batched architecture, chunked cuFFT, auto-tuning, and design decisions table
  • Added Performance section with benchmarks (RTX 4050) and hardware requirements
  • Added all missing CLI flags to usage table: --gpu, --device, --biort, --qshift
  • Added GPU Docker setup section (Dockerfile.gpu, docker-build-gpu.sh, nvidia-container-toolkit)
  • Added v2.0.0 Breaking Changes section (default filter change, how to restore old behavior)
  • Updated project structure tree with all missing files
  • Updated development section with GPU test documentation (tests/test_motion_mag_gpu.py, ./test.sh gpu)
  • Added ASCII pipeline diagram to Algorithm Pipeline section

Fixes #19

Test plan

  • Docs-only change — no code modified
  • Verify README renders correctly on GitHub

🤖 Generated with Claude Code

@joeljose
joeljose merged commit c6c97bb into main Mar 21, 2026
1 check passed
@joeljose
joeljose deleted the docs/update-readme-gpu-v2 branch March 21, 2026 10:04
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.

Update README to document GPU acceleration and v2.0.0 features

1 participant