Commit 21cbeda
Fixes #8106
### Description
The installation docs did not make it clear that some MONAI transforms
require CuPy for GPU-accelerated array operations. Users who ran GPU
inference hit `OptionalImportError: import cupy (No module named
'cupy')` with no obvious guidance — `pip install cupy` fails because the
real package is CUDA-version specific (`cupy-cuda12x`), and it was not
documented that the `cucim` extra provides CuPy.
This PR updates `docs/source/installation.md` to:
- Promote the GPU/CUDA setup steps into their own `## GPU-enabled
installation (CUDA and CuPy)` section (with a Table of Contents entry)
instead of an unlabeled paragraph.
- Explain that some transforms use CuPy (e.g. via `convert_to_cupy`),
what error appears when it is missing, and that CuPy is installed
through the `cucim` extra (`pip install 'monai[cucim]'`).
- Note that installing CuPy directly requires the CUDA-specific package
name (`cupy-cuda12x` / `cupy-cuda11x`), linking to the CuPy installation
guide.
- Add a cross-reference from the recommended-dependencies list.
Docs-only change; no code or public API is modified.
### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.
---------
Signed-off-by: Lanre Shittu <136805224+Shizoqua@users.noreply.github.com>
Co-authored-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
1 parent aca533a commit 21cbeda
1 file changed
Lines changed: 30 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
33 | | - | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
34 | 39 | | |
35 | 40 | | |
36 | | - | |
| 41 | + | |
37 | 42 | | |
38 | | - | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
39 | 64 | | |
40 | 65 | | |
41 | 66 | | |
| |||
184 | 209 | | |
185 | 210 | | |
186 | 211 | | |
187 | | - | |
| 212 | + | |
188 | 213 | | |
189 | 214 | | |
190 | 215 | | |
| |||
212 | 237 | | |
213 | 238 | | |
214 | 239 | | |
215 | | - | |
| 240 | + | |
216 | 241 | | |
217 | 242 | | |
218 | 243 | | |
| |||
0 commit comments