Skip to content

Commit

Permalink
Updated INSTALL.md with CUDA_HOME-related troubleshooting (#140)
Browse files Browse the repository at this point in the history
This is referring to #137 , which in itself refers to a common problem during installation, mentioned on #19 .

Some users may encounter significant trouble installing the project, running into the error `OSError: CUDA_HOME environment variable is not set. Please set it to your CUDA install root.`. Simply adding the `--no-build-isolation` flag to the pip install, e.g. `pip install --no-build-isolation -e .`, usually solves this problem. However, this fix is not mentioned anywhere within the readmes or installation troubleshooting docs. This PR adds this recommendation into the INSTALL.md file under the "My installation failed with `CUDA_HOME environment variable is not set` " section, ensuring that more users are aware of this potential fix.

Examples of users experiencing related difficulties when installing:
#19
#41
#99
#133
  • Loading branch information
AmmoniumX authored Aug 6, 2024
1 parent 0bac418 commit 511199d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ Also, you should make sure
python -c 'import torch; from torch.utils.cpp_extension import CUDA_HOME; print(torch.cuda.is_available(), CUDA_HOME)'
```
print `(True, a directory with cuda)` to verify that the CUDA toolkits are correctly set up.

If you are still having problems after verifying that the CUDA toolkit is installed and the `CUDA_HOME` environment variable is set properly, you may have to add the `--no-build-isolation` flag to the pip command:
```
pip install --no-build-isolation -e .
```

</details>

<details>
Expand Down

0 comments on commit 511199d

Please sign in to comment.