NVIDIA / NVIDIA/cudf

Improve "print_env.sh" experience for reporting issues

Open
#15,609 6 comments 0 reactions 0 assignees View on GitHub
doc Python
Dominant language
C++
Stars
9.8k
Forks
1.1k
Avg merge
3d 6m
Merged PRs (30d)
278

Description

In #15589, @betatim had difficulty finding the [`print_env.sh` script](https://github.com/rapidsai/cudf/blob/branch-24.06/print_env.sh) that is requested as a part of filing an issue.

> Is there a way to provide the same information via something like `import cudf; cudf.print_env()`?

This is probably a viable alternative to the shell script we currently recommend. I think we could re-evaluate the contents of that script. The downside would be that users having installation troubles wouldn't be able to import the package to call such a function -- but the environment information might still be helpful for diagnosis.

Also, it seems to me that many users skip the step of reporting environment information, so either the `print_env.sh` script is hard to find or issue reporters don't think it is important.

xref: https://github.com/rapidsai/cudf/issues/15589#issuecomment-2083061696

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.