Skip to content

docs(vortex-spatial): add crate overview - #9683

Open
HarukiMoriarty wants to merge 1 commit into
developfrom
nemo/spatial-docs
Open

docs(vortex-spatial): add crate overview#9683
HarukiMoriarty wants to merge 1 commit into
developfrom
nemo/spatial-docs

Conversation

@HarukiMoriarty

@HarukiMoriarty HarukiMoriarty commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the structure and current capabilities of vortex-spatial so future contributors have a single place to start.

Changes

  • explain the native geometry storage model and supported compute functions
  • document session setup, AABB pruning, Arrow and DuckDB interop, and current limits
  • use the crate README for package metadata and the Rustdoc landing page
  • correct the crate description and initialize documentation

Signed-off-by: Nemo Yu <zyu379@wisc.edu>
@codspeed-hq

codspeed-hq Bot commented Aug 28, 2026

Copy link
Copy Markdown

Merging this PR will regress 1 benchmark

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 3 improved benchmarks
❌ 1 regressed benchmark
✅ 2153 untouched benchmarks
⏩ 106 skipped benchmarks1
🗄️ 4 archived benchmarks run2

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation cold_misaligned[(16, 64)] 345.6 µs 392.8 µs -12.02%
WallTime arrow_checked_add_u32_avx512[16384] 21.3 µs 17.6 µs +21.31%
WallTime arrow_checked_add_u32_avx2[16384] 21.3 µs 17.7 µs +20.22%
WallTime words_gather_scalar_avx2[65536] 9.4 µs 8.3 µs +13.52%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing nemo/spatial-docs (b76253e) with develop (68e2aee)

Open in CodSpeed

Footnotes

  1. 106 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. 4 benchmarks were run, but are now archived. If they were deleted in another branch, consider rebasing to remove them from the report. Instead if they were added back, click here to restore them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/docs A docs change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant