diff --git a/docs/quickstart/installation.md b/docs/quickstart/installation.md index 5d53a4d0c..81a64b024 100644 --- a/docs/quickstart/installation.md +++ b/docs/quickstart/installation.md @@ -1,8 +1,35 @@ # Installation ## Prerequisites +::::::{tab-set} +:::::{tab-item} Linux -CUDA must be installed on the system. This library has been tested with version 11.3. You can find more information about installing CUDA [here](https://docs.nvidia.com/cuda/cuda-quick-start-guide/index.html) +Install CUDA. This library has been tested with version 11.3. You can find CUDA download links [here](https://developer.nvidia.com/cuda-toolkit-archive) and more information about installing CUDA [here](https://docs.nvidia.com/cuda/cuda-quick-start-guide/index.html). + +::::: +:::::{tab-item} Windows +Install [Git](https://git-scm.com/downloads). + +Install CUDA. This library and the Windows installation process has been tested with version 11.3. + +::::{tab-set} +:::{tab-item} 11.3 with Visual Studio 2019 v16.9 + +Install Visual Studio 2019 ver 16.9. This must be done before installing CUDA. The necessary components are included in the `Desktop Development with C++` workflow (also called `C++ Build Tools` in the BuildTools edition). You can find older versions of Visual Studio 2019 [here](https://learn.microsoft.com/en-us/visualstudio/releases/2019/history#release-dates-and-build-numbers). The latest version, 16.11, may cause errors when installing tiny-cuda-nn. + +Install CUDA 11.3. You can find CUDA download links [here](https://developer.nvidia.com/cuda-toolkit-archive) and more information about installing CUDA [here](https://docs.nvidia.com/cuda/cuda-quick-start-guide/index.html). + +::: +:::{tab-item} 11.7 with Visual Studio 2022 + +Install Visual Studio 2022. This must be done before installing CUDA. The necessary components are included in the `Desktop Development with C++` workflow (also called `C++ Build Tools` in the BuildTools edition). + +Install CUDA 11.7. You can find CUDA download links [here](https://developer.nvidia.com/cuda-toolkit-archive) and more information about installing CUDA [here](https://docs.nvidia.com/cuda/cuda-quick-start-guide/index.html). + +::: +:::: +::::: +:::::: ## Create environment @@ -20,7 +47,8 @@ python -m pip install --upgrade pip (pytorch)= ### pytorch -Either pytorch 1.12.1 (with CUDA up to 11.3) or 1.13.1 (with CUDA 11.6/7/8) can be used. +::::{tab-set} +:::{tab-item} Torch 1.12.1 with CUDA 11.3 - To install 1.12.1 with CUDA 11.3: @@ -28,6 +56,9 @@ Either pytorch 1.12.1 (with CUDA up to 11.3) or 1.13.1 (with CUDA 11.6/7/8) can pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html ``` +::: +:::{tab-item} Torch 1.13.1 with CUDA 11.7 + - To install 1.13.1 with CUDA 11.7: Note that if a pytorch version prior to 1.13 is installed, @@ -37,12 +68,15 @@ it should be uninstalled first to avoid upgrade issues (e.g. with functorch) pip uninstall torch torchvision functorch ``` -Install pytorch 1.13.1 with CUDA (this repo has been tested with CUDA 11.7.1) and [tiny-cuda-nn](https://github.com/NVlabs/tiny-cuda-nn) +Install pytorch 1.13.1 with CUDA and [tiny-cuda-nn](https://github.com/NVlabs/tiny-cuda-nn) ```bash pip install torch torchvision functorch --extra-index-url https://download.pytorch.org/whl/cu117 ``` +::: +:::: + ### tinycudann After pytorch, install the torch bindings for tinycudann: @@ -102,7 +136,7 @@ or be built from the repository using docker build --tag nerfstudio -f Dockerfile . ``` ### Using an interactive container -The docker container can be launched with an interactive terminal where nerfstudio commands can be entered as usual. Some parameters are required and some are strongly reocmmended for usage as following: +The docker container can be launched with an interactive terminal where nerfstudio commands can be entered as usual. Some parameters are required and some are strongly recommended for usage as following: ```bash docker run --gpus all \ # Give the container access to nvidia GPU (required). -v /folder/of/your/data:/workspace/ \ # Mount a folder from the local machine into the container to be able to process them (required). @@ -148,13 +182,15 @@ K80 | 37 ## Installation FAQ -- [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-error) +- [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-mismatch-error) +- [TinyCUDA installation errors out with no CUDA toolset found](tiny-cuda-integration-error) +- [TinyCUDA installation errors out with syntax errors](tiny-cuda-syntax-error) - [Installation errors, File "setup.py" not found](pip-install-error) - [Runtime errors, "len(sources) > 0".](cuda-sources-error)
-(tiny-cuda-error)= +(tiny-cuda-mismatch-error)= **TinyCUDA installation errors out with cuda mismatch** @@ -167,6 +203,67 @@ See [pytorch](pytorch) under Dependencies, above.
+(tiny-cuda-integration-error)= + +**(Windows) TinyCUDA installation errors out with no CUDA toolset found** + +While installing tiny-cuda on Windows, you run into: `No CUDA toolset found.` + +**Solution**: + +Confirm that you have Visual Studio installed (CUDA 11.3 is only compatible up to 2019 ver 16.9, not 16.11 or 2022). + +Make sure CUDA Visual Studio integration is enabled. This should be done automatically by the CUDA installer if it is run after Visual Studio is installed. You can also manually enable integration. + +::::{tab-set} +:::{tab-item} Visual Studio 2019 + +To manually enable integration for Visual Studio 2019, copy all 4 files from + +``` +C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.3\extras\visual_studio_integration\MSBuildExtensions +``` + +to + +``` +C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Microsoft\VC\v160\BuildCustomizations +``` + +::: +:::{tab-item} Visual Studio 2022 + +To manually enable integration for Visual Studio 2022, copy all 4 files from + +``` +C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.7\extras\visual_studio_integration\MSBuildExtensions +``` + +to + +``` +C:\Program Files\Microsoft Visual Studio\2022\[Community, Professional, Enterprise, or BuildTools]\MSBuild\Microsoft\VC\v160\BuildCustomizations +``` + +::: +:::: + +
+ +(tiny-cuda-syntax-error)= + +**(Windows) TinyCUDA installation errors out with syntax errors** + +While installing tiny-cuda on Windows, you run into: `Expected a "("` + +**Solution**: + +If you are using CUDA 11.3 with Visual Studio 2019, confirm that Visual Studio is on version 16.9 and not 16.11. + +If you are using a different version of CUDA and Visual Studio, try switching to CUDA 11.3 with Visual Studio 2019 ver 16.9. + +
+ (pip-install-error)= **Installation errors, File "setup.py" not found**