Skip to content

Use professional wording in env report docs #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liujane-dev wants to merge 2 commits into
base: develop
Choose a base branch
from
+5 −5
Open

Use professional wording in env report docs #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6238312
Use professional wording in env report docs
liujane-dev Jul 20, 2026
5963602
versions is -> versions are
liujane-dev Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ body:
### Environment (where applicable)

<!-- Python users: run `python -m cudnn.collect_env` and paste its output
here instead of filling the fields below. If `import cudnn` is broken,
here instead of filling the fields below. If `import cudnn` fails,
download and run the script standalone with any Python:
https://raw.githubusercontent.com/NVIDIA/cudnn-frontend/main/python/cudnn/collect_env.py -->

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ When filing a bug, include the output of the environment collector — it report
python -m cudnn.collect_env
```

If `import cudnn` itself is broken, download [collect_env.py](python/cudnn/collect_env.py) and run it standalone with any Python.
If `import cudnn` itself fails, download [collect_env.py](python/cudnn/collect_env.py) and run it standalone with any Python.

### Overriding the CUDA runtime library

Expand Down
6 changes: 3 additions & 3 deletions python/cudnn/collect_env.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

python -m cudnn.collect_env
python -m cudnn.collect_env --json
# If `import cudnn` itself is broken, download and run standalone:
# If `import cudnn` itself fails, download and run standalone:
curl -OL https://raw.githubusercontent.com/NVIDIA/cudnn-frontend/main/python/cudnn/collect_env.py
python collect_env.py

Design constraints (please preserve when editing):
- Only stdlib imports at module level, so the file runs standalone even when
cudnn / torch are broken or absent.
cudnn / torch fail to import or are absent.
- Every probe is individually guarded; a failure becomes a value in the
report, never an exception. The report must always print.
- Strictly offline and read-only.
Expand All @@ -33,7 +33,7 @@
# Keys are display names, values are regexes matched against .so basenames.
# libcudnn intentionally also matches the sublibraries (libcudnn_ops,
# libcudnn_engines_precompiled, ...) — an install with mixed sublibrary
# versions is a classic broken state this report must surface.
# versions are a known inconsistent state this report must surface.
_LIB_FAMILIES = {
"libcudnn": r"libcudnn(?:_[a-z_]+)?\.so",
"libcublas": r"libcublas(?:Lt)?\.so",
Expand Down