Repository navigation
Add guidance for coding agents - #84
Merged
Merged
Conversation
nvssatoor
reviewed
Oct 23, 2026
Collaborator
Author
|
I've made some improvements to the guidance, the main things are:
@nvssatoor please re-review |
Describe the repository layout, the lint/test/docs commands, runtime requirements, and how the profiler runs benchmark code. Document known pitfalls found while profiling Triton kernels with the NCU and CUPTI backends: autotuning inside annotations, kernel-count rules, CUPTI activation order relative to importing torch, mangled kernel names under CUPTI, and how to interpret result columns including normalize_against. Some passages describe the error messages from the acollins/errors-and-terminal-output branch, so this builds on it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
Separate guidance for using Nsight Python from guidance for working on the repository, generalize the Triton-specific pitfalls, and point to the docs and code for versions, result columns and CI details instead of restating them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
Print the full result table, and explain how to profile a candidate made of several PyTorch ops, including that summing is wrong for percentage metrics. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
acollins3
force-pushed
the
acollins/agents-md
branch
from
November 2, 2026 12:04
6259463 to
6c198f9
Compare
nvssatoor
reviewed
Nov 2, 2026
nvssatoor
reviewed
Nov 2, 2026
nvssatoor
reviewed
Nov 2, 2026
nvssatoor
reviewed
Nov 2, 2026
Collaborator
|
It may be useful to review and update the nsight python document - if any of these points mentioned in agents.md are not included. This can be done in a separate change. |
Collaborator
Author
Agreed, I'll do it in a follow-up PR. Here's my current list of omissions from the docs that we should add:
Once those are in the docs, AGENTS.md can point to them instead of repeating them. |
State why CUPTI timings vary more, limit the MPLBACKEND advice to Windows where it is needed, and explain what the default exception behavior inside annotations means for a sweep. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Alex Collins <acollins@nvidia.com>
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.
Describe the repository layout, the lint/test/docs commands, runtime requirements, and how the profiler runs benchmark code. Document known pitfalls found while profiling Triton kernels with the NCU and CUPTI backends: autotuning inside annotations, kernel-count rules, CUPTI activation order relative to importing torch, mangled kernel names under CUPTI, and how to interpret result columns including normalize_against.
Some passages describe the error messages from #83, so this builds on it.