Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SDK Manager and updated CUDA install options #547

Merged
merged 30 commits into from
Feb 3, 2025
Merged
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ec91691
Add SDK Manager and updated install options
taureandyernv Oct 8, 2024
b119dbc
added more cuda versions
taureandyernv Oct 8, 2024
9f2c53c
update CUDA version
taureandyernv Oct 9, 2024
bc99789
update CUDA section header
taureandyernv Oct 9, 2024
827094a
fixed text
taureandyernv Oct 9, 2024
ed6eca8
fix CUDA section
taureandyernv Oct 9, 2024
a7ee893
Update install/index.md
taureandyernv Oct 9, 2024
35b6f25
Update install/index.md
taureandyernv Oct 9, 2024
f7fa245
Update install/index.md
taureandyernv Oct 9, 2024
c8f6a4a
Update install/index.md
taureandyernv Oct 9, 2024
f7f90ab
Fix capitalization
taureandyernv Oct 9, 2024
cbdfa7d
dropped notes
taureandyernv Oct 9, 2024
487eea8
Update install/index.md
taureandyernv Oct 9, 2024
7d8aefc
added some code markers
taureandyernv Oct 9, 2024
900f625
formatting
jameslamb Oct 10, 2024
9e4bfc0
removed folder specific comments
taureandyernv Oct 10, 2024
a19bd45
Update index.md
taureandyernv Oct 15, 2024
f76cf52
Merge branch 'main' into sdkm
jameslamb Dec 10, 2024
e3e1b75
updated wsl2 install
taureandyernv Dec 16, 2024
baf65f6
Merge branch 'main' of github.com:rapidsai/docs into sdkm
jameslamb Dec 16, 2024
07260ad
re-run pre-commit
jameslamb Dec 16, 2024
26f318f
Update install/index.md
taureandyernv Dec 17, 2024
c646412
Update install/index.md
taureandyernv Dec 17, 2024
0679716
Update install/index.md
taureandyernv Dec 17, 2024
09d526f
Update install/index.md
taureandyernv Dec 17, 2024
afdd083
Update install/index.md
taureandyernv Dec 17, 2024
464e5db
Update install/index.md
taureandyernv Jan 27, 2025
f5bd4f4
Update install/index.md
taureandyernv Jan 27, 2025
178d916
made the install command for WSL2 copy and paste-able
taureandyernv Jan 30, 2025
4fdcb5d
Remove trailing whitespace
bdice Feb 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ RAPIDS has several methods for installation, depending on the preferred environm
- [Conda](#conda)
- [Docker](#docker)
- [pip](#pip)
- [SDK Manager](#sdkm)
- [Windows WSL2](#wsl2)
- [SDK Manager](#wsl2-sdkm)
- [Conda](#wsl2-conda)
- [Docker](#wsl2-docker)
- [pip](#wsl2-pip)
Comment on lines +29 to 32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this below pip? I think we should keep the order "Conda, Docker, pip, SDK Manager" to match the above.

Suggested change
- [SDK Manager](#wsl2-sdkm)
- [Conda](#wsl2-conda)
- [Docker](#wsl2-docker)
- [pip](#wsl2-pip)
- [Conda](#wsl2-conda)
- [Docker](#wsl2-docker)
- [pip](#wsl2-pip)
- [SDK Manager](#wsl2-sdkm)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think we should reorder this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@taureandyernv could you please include this change?

It also lines up with the outline above it and the actual layout in the text below

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@taureandyernv let me know that @aravenel wants this at the top. I will defer to that decision.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To better understand, met with Taurean and Alex today

From that meeting, Taurean clarified that Windows users are primarily looking for a GUI installer, which this meets. Hence promoting this first for the Windows case

The Linux use case is intended to remain the same

Now with a better understanding, agree this is reasonable

Expand Down Expand Up @@ -154,7 +156,7 @@ All provisioned systems need to be RAPIDS capable. Here's what is required:

**Note**: RAPIDS is tested with and officially supports the versions listed above. Newer CUDA and driver versions may also work with RAPIDS. See [CUDA compatibility](https://docs.nvidia.com/deploy/cuda-compatibility/index.html) for details.

## **CUDA 12 Support**
## **CUDA Support**

### **Docker and Conda**

Expand Down Expand Up @@ -185,8 +187,7 @@ If you do not have access to GPU hardware, there are several cloud service provi

Several services also offer **free and limited** trials with GPU resources:
- [Amazon SageMaker Studio Lab](https://studiolab.sagemaker.aws/)
- [Google CoLab w/ pip](https://colab.research.google.com/drive/13sspqiEZwso4NYTbsflpPyNFaVAAxUgr)
- [Google CoLab w/ Conda](https://colab.research.google.com/drive/1TAAi_szMfWqRfHVfjGSqnGVLr_ztzUM9)
- [Google Colab w/ pip](https://nvda.ws/3XEO6hK)
- [PaperSpace](https://www.paperspace.com/gpu-cloud)

<hr/>
Expand Down Expand Up @@ -280,6 +281,19 @@ RAPIDS pip packages are available for CUDA 11 and CUDA 12 on the NVIDIA Python P
<i class="fas fa-info-circle"></i> **glibc version:** x86_64 wheels require glibc >= 2.17. <br/>
<i class="fas fa-info-circle"></i> **glibc version:** ARM architecture (aarch64) wheels require glibc >= 2.32 (only ARM Server Base System Architecture is supported).

<br/>
<div id="sdkm"></div>

## **SDK Manager (Ubuntu Only)**
[NVIDIA SDK Manager](https://developer.nvidia.com/sdk-manager) gives a users a Graphical User Interface (GUI) option to install RAPIDS. It also attempts to fix any environment issues before installing RAPIDS or updating RAPIDS, making it ideal for new Linux users.
1. Download [SDK Manager's Ubuntu version from their website](https://developer.nvidia.com/sdk-manager){: target="_blank"} (requires sign up or login to NVIDIA's Developer community). Do not install yet. It is assumed that your home directory's `Downloads` folder is where the `.deb` file will be stored. If not, please move `sdkmanager_[version]-[build#]_amd64.deb` file to your current Download folder.
2. Install and run SDK Manager [using the installation guide here](https://docs.nvidia.com/sdk-manager/download-run-sdkm/index.html){: target="_blank"}. For Ubuntu, use the following commands:
```bash
sudo apt install ./sdkmanager_[version]-[build#]_amd64.deb
sdkmanager
```
3. Sign in when asked, and follow SDK Manager's [RAPIDS installation instructions](https://docs.nvidia.com/sdk-manager/install-with-sdkm-rapids/index.html){: target="_blank"}.


<br/>
<div id="wsl2"></div>
Expand Down Expand Up @@ -310,10 +324,31 @@ Windows users can now tap into GPU accelerated data science on their local machi

<i class="fas fa-info-circle text-white"></i> When installing with Docker Desktop, if the container pull command is successful, but the run command hangs indefinitely, [ensure you're on Docker Desktop >= 4.18](https://docs.docker.com/desktop/release-notes/){: target="_blank"}.

<br/>
<div id="wsl2-sdkm"></div>

### **WSL2 SDK Manager Install**
[NVIDIA's SDK Manager](https://developer.nvidia.com/sdk-manager){: target="_blank"} gives Windows users a Graphical User Interface (GUI) option to install RAPIDS. It also attempts to fix any environment issues before installing RAPIDS or updating RAPIDS, making it ideal for new WSL users.
1. Install the [latest NVIDIA Drivers](https://www.nvidia.com/en-us/drivers/){: target="_blank"} on the Windows host.
2. Download [SDK Manager's Ubuntu version from their website](https://developer.nvidia.com/sdk-manager){: target="_blank"} (requires sign up or login to NVIDIA's Developer community). Do not install yet. The rest of the instructions assume that your home directory's `Downloads` folder is where the `.deb` file will be stored. If this is not the case, please change the directory, as needed, for your system.
3. Install or update WSL2 and the Ubuntu 22.04 or Ubuntu 24.04 package [using Microsoft's instructions](https://docs.microsoft.com/en-us/windows/wsl/install){: target="_blank"}. To install Ubuntu 24.04 from the command line, use this command:
```bash
wsl --install -d Ubuntu-24.04
```
This will install and start Ubuntu in your Windows host system using WSL2. Make your **sudo** password memorable as you will need it in the next two steps.
4. Install and run SDK Manager inside Ubuntu by pasting this into your command line. This command will navigate to your Windows users's `Downloads` folder, from your WSL2 instance, and install the latest SDK Manager `.deb` file that you had downloaded. You will have to enter the sudo password you created when you installed Ubuntu.
```bash
sudo apt update && sudo apt install wslu -y
cd "$(wslpath -au "$(cmd.exe /c 'echo %USERPROFILE%' | tr -d '\r')")/Downloads"
sudo apt install "$(ls -t ./sdkmanager_*_amd64.deb | head -n 1)" -y
sdkmanager
```
5. Sign in when asked, and [follow SDK Manager's RAPIDS installation instructions here](https://docs.nvidia.com/sdk-manager/install-with-sdkm-rapids/index.html){: target="_blank"}.

<br/>
<div id="wsl2-conda"></div>

### **WSL2 Conda Install (Preferred Method)**
### **WSL2 Conda Install**

1. Install WSL2 and the Ubuntu distribution [using Microsoft's instructions](https://docs.microsoft.com/en-us/windows/wsl/install){: target="_blank"}.
2. Install the [latest NVIDIA Drivers](https://www.nvidia.com/download/index.aspx){: target="_blank"} on the Windows host.
Expand Down