Make the repository agent-friendly: AGENTS.md guides, llms.txt, skills discovery - #402
Merged
Merged
Conversation
…s discovery Add agent-facing documentation so coding agents (and new contributors) can build, test, and follow repo conventions without reverse-engineering setup.py/CMake: - AGENTS.md: repo map, environment requirements, verified build/test/ format commands, conventions, runtime debug env vars - Scoped guides: include/cudnn_frontend/AGENTS.md (header-only rules, graph layering, generated/ + experimental/), python/cudnn/AGENTS.md (APIBase contract, lazy-import rules, new-API checklist), test/AGENTS.md (conftest landmines, L0-L4 markers, layout), samples/AGENTS.md - .claude/skills -> ../skills symlink so Claude Code auto-discovers the existing cutedsl-kernel-integration skill - llms.txt: curated docs index for retrieval-style agents, pointing at the published documentation site - CONTRIBUTING.md: add development-environment, test, and formatting sections; document develop as the PR base branch All documented commands were verified on a SM100 GPU machine (cmake configure/build, Catch2 binary, pip install -e ".[cutedsl]", pytest L0 and fe_api smoke runs, pre-commit). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Anerudhan
marked this pull request as ready for review
July 17, 2026 00:27
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (8)
📝 WalkthroughWalkthroughThis change adds repository-wide and component-specific agent guides, expands contribution and development documentation, introduces a curated ChangesRepository Guidance
Estimated code review effort: 2 (Simple) | ~10 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Merged
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
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.
Before submitting
pre-commit runand committed any formatting changes.Affected area
Documentation or samples
Summary
Make the repository agent-friendly (for coding agents like Claude Code, Codex, Cursor — and equally useful to new human contributors):
AGENTS.md(root): repo map, environment requirements, verified build/test/format commands, conventions, runtime debug env vars, links (published docs at docs.nvidia.com).include/cudnn_frontend/AGENTS.md(header-only rules, graph layering,generated/+experimental/),python/cudnn/AGENTS.md(APIBase contract, lazy-import rules, new-API checklist),test/AGENTS.md(conftest landmines, L0–L4 markers, layout),samples/AGENTS.md..claude/skills→../skillssymlink so Claude Code auto-discovers the existingcutedsl-kernel-integrationskill (degrades to a harmless text file on Windows checkouts without symlink support).llms.txt: curated docs index for retrieval-style agents (llms.txt convention).CONTRIBUTING.md: added development-environment, test-running, and formatting sections; documenteddevelopas the PR base branch.Why
Agents (and new contributors) currently have to reverse-engineer
setup.py/CMake for build commands, and critical test-suite constraints (TransformerEngine import order,PYTORCH_CUDA_ALLOC_CONFtiming, L0 marker default) live only as comments inconftest.py. This surfaces them in the standard discovery locations.Related issues
None.
API and compatibility impact
None — documentation and a symlink only. No code changes.
Testing
Every documented command was executed on an SM100-class GPU machine (CUDA 13.2, system cuDNN 9.8, Python 3.10) before being written down:
cmake -B build -DCMAKE_BUILD_TYPE=Release+cmake --build build -j— success, producesbuild/bin/{samples,legacy_samples,tests}./build/bin/tests --list-tests,./build/bin/tests "Validate conv node"— passedpip install -e .andpip install -e ".[cutedsl]"— success;import cudnnreports FE 1.27.0 / backend 90800cd test/python && pytest test_conv_fprop.py— 2 passed (L0 default)pytest fe_api/gemm/test_gemm_swiglu.py— runs end to end (500 passed, 460 skipped; 64 pre-existing numerical failures on this machine, unrelated to this docs-only change)pre-commit run— clean on the changed filesNotes for reviewers:
pre-commit run --all-filescurrently reformats several pre-existing files ondevelop(e.g.thirdparty/nlohmann/json.hppvia clang-format, a few notebooks and .py files via black). Those reformats were deliberately excluded; the guides therefore recommend running pre-commit on changed files only.developas the PR base (matching this repo's current branch setup). Please confirm the wording matches intended policy.🤖 Generated with Claude Code
Summary by CodeRabbit
llms.txt, a curated index of documentation, references, guides, examples, and resources.