search

hpc / charliecloud

Now hosted on GitLab.
https://gitlab.com/charliecloud/main
Apache License 2.0
313 stars 61 forks source link

ch-fromhost --nvidia: improve documentation #939

Open reidpr opened 3 years ago

reidpr commented 3 years ago

Currently, if ch-fromhost --nvidia can't find nvidia-container-cli, the error message is not so good:

$ ch-fromhost --nvidia $img
ch-fromhost: 204: ch-fromhost: nvidia-container-cli: not found
ch-fromhost: nvidia-container-cli failed; does this host have GPUs?

Problems include:

  1. ch-fromhost repeated in the first line
  2. No explanation of what nvidia-container-cli is, or what to do about it being missing
  3. implication that host doesn't have GPUs is misleading

Further, the nvidia-container-cli dependency is not documented.

This issue is to clean up the error message, write some documentation about what nvidia-container-cli is and how to install it (it's easy), and point to those docs in the error.

pramodk commented 3 years ago

Same issue here - couldn't figure out what is missing and how to fix it. Certainly helpful to have some documentation!

reidpr commented 3 years ago

Thanks for the nudge, @pramodk!

If you'd like support on your particular situation pending this bugfix, please do open a Discussion and we'll help you out.