Skip to content

[no-ci] Correct stale bindings and core contributor guidance - #3194

Merged
rwgk merged 1 commit into
NVIDIA:mainfrom
rwgk:rwgk/fix-stale-contributor-guidance
Oct 23, 2026
Merged

[no-ci] Correct stale bindings and core contributor guidance#3194
rwgk merged 1 commit into
NVIDIA:mainfrom
rwgk:rwgk/fix-stale-contributor-guidance

Conversation

@rwgk

@rwgk rwgk commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Description

While researching the shared agent-skills proposal in #3192, we found stale contributor guidance in the bindings and core documentation. Correct it immediately so contributors and agents can follow the current paths, commands, and runtime contracts while the broader skills proposal is discussed.

  • Correct the bindings legacy-test, Cython-test, and sample paths; use the existing Pixi sample task and link to the maintained Python/C++ benchmark instructions.
  • Distinguish Python host callbacks and GIL-taking owner cleanup from CUDA user-object destructor callbacks, which enqueue deferred cleanup without acquiring the GIL. Align the core agent guidance and runtime design document.
  • Correct typing.TYPE_CHECK to typing.TYPE_CHECKING.

Related to #3192; the shared skills infrastructure remains tracked there. This PR changes documentation only.

Validation

  • pre-commit run --files cuda_bindings_13/AGENTS.md cuda_bindings_13/README.md cuda_core/AGENTS.md cuda_core/cuda/core/_cpp/rt/DESIGN.md: passed, including link checks.
  • git diff --check: passed.
  • Verified the guidance against the current test directories, Pixi tasks, host callback trampoline, and deferred-cleanup implementation. No runtime tests or benchmarks were needed for these documentation-only changes.

Review And CI

Ready for human review. Kept in draft to retain manual control over triggering full CI.

Checklist

  • Validation appropriate to these documentation-only changes is complete.
  • The documentation is up to date with these changes.

@rwgk rwgk added this to the cuda.core 1.3.0 milestone Oct 22, 2026
@rwgk rwgk added documentation Improvements or additions to documentation cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Oct 22, 2026
@copy-pr-bot

copy-pr-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@rwgk rwgk self-assigned this Oct 22, 2026
@rwgk rwgk changed the title [doc-only] Correct stale bindings and core contributor guidance [no-ci] Correct stale bindings and core contributor guidance Oct 22, 2026
@rwgk
rwgk marked this pull request as ready for review October 22, 2026 22:15
@coderabbitai

coderabbitai Bot commented Oct 22, 2026

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between afa6249 and ba1451c.

📒 Files selected for processing: 4
  • cuda_bindings_13/AGENTS.md
  • cuda_bindings_13/README.md
  • cuda_core/AGENTS.md
  • cuda_core/cuda/core/_cpp/rt/DESIGN.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated testing guidance to point to the current sample coverage and Cython test locations, with instructions for running sample tests.
    • Revised sample and benchmark documentation with links to examples, benchmark environments, commands, and result comparisons.
    • Clarified guidance on CUDA callback behavior, including restrictions on driver calls, GIL acquisition, and Python-object access in user-object destructor callbacks.

The pull request updates bindings test, sample, and benchmark documentation. It also clarifies core guidance on GIL use and deferred cleanup for CUDA user-object destructor callbacks, and corrects a type-checking import reference.

Changes: Bindings test and benchmark guidance

Layer / File(s) Summary
Test and sample instructions
cuda_bindings_13/AGENTS.md, cuda_bindings_13/README.md		 The guidance points to updated Cython and legacy-test paths, sample documentation, and the pixi run test-samples command.
Benchmark instructions
cuda_bindings_13/AGENTS.md, cuda_bindings_13/README.md		 The benchmark guidance links to Python and C++ benchmark resources and Pixi task instructions.

Core callback and GIL guidance

Layer / File(s) Summary
Callback and type-checking guidance
cuda_core/AGENTS.md, cuda_core/cuda/core/_cpp/rt/DESIGN.md		 The documentation identifies paths that may acquire the GIL and states that CUDA user-object destructor callbacks defer cleanup without acquiring the GIL, accessing Python objects, or calling the driver. It also corrects typing.TYPE_CHECKING.

Possibly related issues

  • NVIDIA/cuda-python#3192: Both changes update bindings and core agent guidance. This pull request does not add the shared skills layout.

Suggested reviewers: mdboom

Priority: ⬇️ Low

Change: Other

Merge Risk: ⚪ Minimal · up to ba145

The documentation updates are mergeable with no identified implementation risk.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@rwgk
rwgk requested a review from Andy-Jost October 22, 2026 23:02
@rwgk

rwgk commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @Andy-Jost!

@rwgk
rwgk merged commit fd33836 into NVIDIA:main Oct 23, 2026
39 checks passed
@rwgk
rwgk deleted the rwgk/fix-stale-contributor-guidance branch October 23, 2026 17:42
@coderabbitai coderabbitai Bot mentioned this pull request Oct 23, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Andy-Jost Andy-Jost Andy-Jost approved these changes

Assignees

@rwgk rwgk

Labels

cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation

Projects

None yet

Milestone

cuda.core 1.3.0

Development

Successfully merging this pull request may close these issues.

2 participants

@rwgk @Andy-Jost