aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2022-08-30 00:19:59 +0300
committerGitHub <noreply@github.com>2022-08-30 00:19:59 +0300
commit6851eadfcb7410d788d655711136ab8e41d476e5 (patch)
treee5a4bf4177346f27d0d619221623d3a0d851a513
parent2e928d96edd3d8e3f154ba23d07a4e4e797bf421 (diff)
Automated documentation update (#120)
Automated documentation update [skip ci] Co-authored-by: github-actions <github-actions@github.com>
-rw-r--r--src/nvidia-cuda/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/nvidia-cuda/README.md b/src/nvidia-cuda/README.md
index 22cb950..331d977 100644
--- a/src/nvidia-cuda/README.md
+++ b/src/nvidia-cuda/README.md
@@ -22,6 +22,25 @@ Installs shared libraries for NVIDIA CUDA.
| cudaVersion | Version of CUDA to install | string | 11.7 |
| cudnnVersion | Version of cuDNN to install | string | 8.5.0.96 |
+## Compatibility
+
+This Feature adds shared libraries for NVIDIA CUDA and is only useful for devcontainers that run on a host machine with an NVIDIA GPU. Within your devcontainer, use the `nvidia-smi` command to ensure that your GPU is available for CUDA.
+
+If the `nvidia-smi` command is not available within your devcontainer, you may need to complete the following steps:
+
+### Install the NVIDIA Container Toolkit
+
+Follow [NVIDIA's instructions to install the NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/overview.html) on your host machine. The NVIDIA Container Toolkit is available on a variety of Linux distributions. Make sure you have installed the NVIDIA driver for your Linux distribution before installing the NVIDIA Container Toolkit.
+
+### Enable GPU passthrough
+
+Enable GPU passthrough to your devcontainer by adding `["--gpus", "all"]` to your devcontainer's `runArgs` property. Here's an example of a devcontainer with this property:
+
+```json
+{
+ "runArgs": ["--gpus", "all"]
+}
+```
---