Add NanoVDB TEACHME interactive tutorial + docs-compile test harness#2226
Open
harrism wants to merge 1 commit into
Open
Add NanoVDB TEACHME interactive tutorial + docs-compile test harness#2226harrism wants to merge 1 commit into
harrism wants to merge 1 commit into
Conversation
harrism
force-pushed
the
nanovdb-teachme
branch
6 times, most recently
from
be3d2b9 to
c4c5e8e
Compare
doc/nanovdb/TEACHME/ is an interactive, LLM-guided tutorial for the NanoVDB user API: 10 modules (reading grids, ReadAccessor, math/HDDA sampling, GPU kernels, GPU grid builders, topology operators + data re-homing via Injection, IndexGrid/VoxelBlockManager, OpenVDB conversion), a cheat sheet, and a GPU level-set ray-march capstone. To keep the tutorial from drifting from the API, the test harness in doc/nanovdb/TEACHME/test/ extracts every C++/CUDA code block from the docs and compiles it against the real NanoVDB headers, and validates that every #include and prose header reference resolves. ~64 blocks compile green. A CI workflow (.github/workflows/teachme.yml) runs the harness whenever the NanoVDB headers or the tutorial change, so API drift is caught automatically. It is compile-only and needs no GPU. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Mark Harris <mharris@nvidia.com>
harrism
requested review from
Idclip,
apradhana,
danrbailey,
jmlait and
richhones
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
doc/nanovdb/TEACHME/— an interactive, LLM-guided tutorial for theNanoVDB user API, plus a test harness that keeps it from drifting from the
real headers.
nanovdb_user_lesson.md) — 10 modules: sparse-gridfoundations,
GridHandle/IO,ReadAccessor,NodeManager, math + sampling +HDDA, GPU kernels, GPU grid builders (
PointsToGrid/MeshToGrid), topologyoperators + data re-homing (
Injection),IndexGrid/VoxelBlockManager,and OpenVDB ↔ NanoVDB conversion.
nanovdb_user_cheatsheet.md) — one-page API reference.capstone/) — a GPU level-set ray-march renderer (scaffold +reference + CMake), rendering an SDF sphere on the device.
Why a test harness
Markdown code in docs is never compiled, so it silently rots as the API
changes.
test/extracts every C++/CUDA block and compiles it (compile-only)against the real NanoVDB headers, and validates every
#include/ prose headerreference. ~64 blocks compile green; run
test/run.sh. This is in the samespirit as the doc-quality CI gates being added in #2217.
A CI workflow (
.github/workflows/teachme.yml) runs the harness whenever theNanoVDB headers (
nanovdb/nanovdb/**) or the tutorial change, so an API changethat breaks a lesson is caught automatically. It's compile-only (~90s on a
standard runner, no GPU) and reuses the existing
aswf/ci-openvdbCUDA image.Notes
the runnable end-to-end check.