Skip to content

docs: add new GPU acceleration guide for spatial joins#774

Merged
zhangfengcdt merged 4 commits into
apache:mainfrom
pwrliang:doc/gpu
Apr 21, 2026
Merged

docs: add new GPU acceleration guide for spatial joins#774
zhangfengcdt merged 4 commits into
apache:mainfrom
pwrliang:doc/gpu

Conversation

@pwrliang
Copy link
Copy Markdown
Contributor

What this PR does

This PR adds a new documentation page at docs/gpu-acceleration.ipynb and docs/gpu-acceleration.md that introduces GPU-accelerated spatial joins in SedonaDB.

Highlights

  • Adds prerequisites for GPU usage (CUDA/version, compute capability, RT core notes).
  • Documents GPU join execution model (filtering + refinement) and supported predicates.
  • Explains fallback behavior with gpu.fallback_to_cpu.
  • Provides build-from-source guidance for GPU (MATURIN_PEP517_ARGS="--features gpu"), including related environment variables.
  • Adds runtime configuration examples for gpu.* options and batch-size tuning.
  • Includes a complete example workflow:
    • check GPU availability (nvidia-smi)
    • download sample data
    • create external tables
    • run CPU vs GPU benchmark in notebook-style code
    • display timing/speedup output

Why

Users need a practical, end-to-end guide to enable, tune, and validate GPU spatial join performance.

Scope

  • Documentation only
  • New file: docs/gpu-acceleration.md
  • No runtime/engine behavior changes

Notes

Benchmark numbers shown in the example are environment-dependent and should be treated as illustrative.

@github-actions github-actions Bot requested a review from zhangfengcdt April 20, 2026 11:48
@zhangfengcdt
Copy link
Copy Markdown
Member

@pwrliang Could you please fix the missing license header error in ci? Thanks!

@pwrliang
Copy link
Copy Markdown
Contributor Author

@pwrliang Could you please fix the missing license header error in ci? Thanks!

Fixed, thank you.

@zhangfengcdt zhangfengcdt merged commit ec643bc into apache:main Apr 21, 2026
4 checks 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.

2 participants