Skip to content

Commit be359c4

Browse files
committed
docs(installation): correct CuPy/cucim extras guidance
- Update GPU/CUDA step to note that PyTorch wheels bundle the CUDA runtime and do not require manual CUDA download or CUDA_PATH. - Replace the statement that CuPy is installed via the cucim extra; CuPy is now installed via the dedicated monai[cupy] extra. The cucim extra only installs cuCIM. - Update CuPy example versions to cupy-cuda13x for CUDA 13.x. - Quote .[all,testing] in editable-install example. - Fix --no-build-isoloation typo. Signed-off-by: Lanre Shittu <136805224+Shizoqua@users.noreply.github.com>
1 parent 20f8e4a commit be359c4

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/source/installation.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Ignite](https://pytorch.org/ignite/), please follow the instructions:
3838
The installation commands below usually end up installing the CPU variant of PyTorch. To install GPU-enabled PyTorch:
3939

4040
1. Install the latest NVIDIA driver.
41-
1. Check [PyTorch Official Guide](https://pytorch.org/get-started/locally/) for the recommended CUDA versions. For Pip package, the user needs to download the CUDA manually, install it on the system, and ensure CUDA_PATH is set properly.
41+
1. Check the [PyTorch Official Guide](https://pytorch.org/get-started/locally/) for the recommended CUDA versions. For Pip packages, PyTorch wheels already bundle the CUDA runtime, so you only need to pick the CUDA version matching your driver from the selector and install with the provided command. You do not need to manually download CUDA or set `CUDA_PATH`.
4242
1. Continue to follow the guide and install PyTorch.
4343
1. Install MONAI using one of the ways described below.
4444

@@ -47,15 +47,18 @@ however, additionally use [CuPy](https://cupy.dev/) for GPU-accelerated array op
4747
when a transform converts a CUDA tensor via `convert_to_cupy`). If CuPy is not installed, these code
4848
paths raise `OptionalImportError: import cupy (No module named 'cupy')`.
4949

50-
CuPy is provided through the `cucim` extra, so installing MONAI with that extra pulls in a compatible
51-
CuPy build:
50+
MONAI provides a dedicated `cupy` extra that installs a compatible CuPy build:
5251

5352
```bash
54-
pip install 'monai[cucim]'
53+
pip install 'monai[cupy]'
5554
```
5655

56+
The `cucim` extra installs [cuCIM](https://github.com/rapidsai/cucim) (`cucim-cu12` or `cucim-cu13`
57+
depending on your Python version), which is a separate GPU image-processing library and does not
58+
install CuPy.
59+
5760
If you prefer to install CuPy directly, note that the PyPI package name is CUDA-version specific
58-
(e.g. `cupy-cuda12x` for CUDA 12.x, `cupy-cuda11x` for CUDA 11.x) rather than plain `cupy`. See the
61+
(e.g. `cupy-cuda12x` for CUDA 12.x, `cupy-cuda13x` for CUDA 13.x) rather than plain `cupy`. See the
5962
[CuPy installation guide](https://docs.cupy.dev/en/stable/install.html) for the correct package for
6063
your CUDA toolkit.
6164

@@ -206,7 +209,7 @@ You can install it by running:
206209
```bash
207210
cd MONAI/
208211
pip install -e .
209-
# or pip install -e .[all,testing] to include most of the dependencies
212+
# or pip install -e '.[all,testing]' to include most of the dependencies
210213
```
211214

212215
or, to build with MONAI C++/CUDA extensions and install:
@@ -234,7 +237,7 @@ $env:BUILD_MONAI="1"
234237
pip install -e .
235238
```
236239

237-
If the compiled extensions were built by pip against a different version of PyTorch than the one in your environment, you may need to run the above with the `--no-build-isoloation` flag to force the use of that version, or use the `--build-constraint` method.
240+
If the compiled extensions were built by pip against a different version of PyTorch than the one in your environment, you may need to run the above with the `--no-build-isolation` flag to force the use of that version, or use the `--build-constraint` method.
238241

239242
To uninstall the package please run:
240243

0 commit comments

Comments
 (0)