Skip to content

Commit

Permalink
Improve docs for using the GPU accelerator directive (#5488) [ci skip]
Browse files Browse the repository at this point in the history
Signed-off-by: adamrtalbot <[email protected]>
  • Loading branch information
adamrtalbot authored Nov 8, 2024
1 parent bdf0ad0 commit 4b90852
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/reference/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,10 @@ The above examples will request 4 GPUs of type `nvidia-tesla-k80`.
This directive is only used by certain executors. Refer to the {ref}`executor-page` page to see which executors support this directive.
:::

:::{note}
Additional options may be required to fully enable the use of accelerators. When using containers with GPUs, you must pass the GPU drivers through to the container. For Docker, this requires the option `--gpus all` in the docker run command. For Apptainer/Singularity, this requires the option `--nv`. The specific implementation details depend on the accelerator and container type being used.
:::

:::{note}
The accelerator `type` option depends on the target execution platform. Refer to the platform-specific documentation for details on the available accelerators:

Expand Down

0 comments on commit 4b90852

Please sign in to comment.