From 51c11b64eaec842a20ba2790751b9244327a6f5f Mon Sep 17 00:00:00 2001 From: Taurean Dyer <46935140+taureandyernv@users.noreply.github.com> Date: Thu, 10 Aug 2023 01:47:05 -0700 Subject: [PATCH] Update colab.md (#266) * Update colab.md * Fix linting * Use myst style anchors * Update source/platforms/colab.md Co-authored-by: Tim Head * Fix links --------- Co-authored-by: Jacob Tomlinson Co-authored-by: Jacob Tomlinson Co-authored-by: Tim Head --- source/platforms/colab.md | 105 +++++++++++++++++++++++++++++++++----- 1 file changed, 93 insertions(+), 12 deletions(-) diff --git a/source/platforms/colab.md b/source/platforms/colab.md index dfb1a3ab..002b8c33 100644 --- a/source/platforms/colab.md +++ b/source/platforms/colab.md @@ -1,10 +1,59 @@ # RAPIDS on Google Colab -## Launch notebook +## Overview + +This guide is broken into two sections: + +1. [RAPIDS Quick Install](colab-quick) - applicable for most users +2. [RAPIDS Custom Setup Instructions](colab-custom) - step by step set up instructions covering the **must haves** for when a user needs to adapt instance to their workflows + +In both sections, will be installing RAPIDS on colab using pip or conda. Here are the differences between the two installation methods + +- Pip installation allows users to install cuDF, cuML, cuGraph, and cuSpatial stable versions in a few minutes (1/5 ease of install) +- Conda installation installs the complete, customized RAPIDS library package (such as installing stable or nightly) however, it can take around 15 minutes to install and has a couple of break points requiring the user to manually continue the installation (2/5 ease of install) + +RAPIDS install on Colab strives to be an "always working" solution, and sometimes will **pin** RAPIDS versions to ensure compatiblity. + +(colab-quick)= + +## Section 1: RAPIDS Quick Install + +### Links + +Please follow the links below to our install templates: + +#### Pip + +1. Open the pip template link by clicking this button --> + + Open In Colab + . +1. Click **Runtime** > **Run All**. +1. Wait a few minutes for the installation to complete without errors. +1. Add your code in the cells below the template. + +#### Conda + +1. Open the conda template link by clicking this button --> + + Open In Colab + . There are instructions in the notebook and below. Default to the Notebook's instructions if they deviate, as below is for reference and additional context. +1. Click **Runtime** > **Run All**. This will NOT run all cells as the installation will pause after updating Colab's gcc. Ignore all Colab alerts. +1. Go to the next unrun cell and run it to install conda. The installation will pause again. Ignore all Colab alerts. +1. Run the test and conda install test cell. +1. Before running the RAPIDS install cell, you can change the installation type between `stable` and `nightly`. Leaving it blank or adding any other words will default to 'stable'. All disclaimers around nightly installs apply. +1. Run the rest of the cells to complete the installation of RAPIDS on Colab. +1. Add your code in the cells below the template. + +(colab-custom)= + +## Section 2: User Customizable RAPIDS Install Instructions + +### 1. Launch notebook To get started in [Google Colab](https://colab.research.google.com/), click `File` at the top toolbar to Create new or Upload existing notebook -## Set the Runtime +### 2. Set the Runtime Click the `Runtime` dropdown and select `Change Runtime Type` @@ -14,36 +63,68 @@ Choose GPU for Hardware Accelerator ![Screenshot of gpu for hardware accelerator](../images/googlecolab-select-gpu-hardware-accelerator.png) -## Check GPU type +### 3. Check GPU type Check the output of `!nvidia-smi` to make sure you've been allocated a Rapids Compatible GPU, i.e [Tesla T4, P4, or P100]. ![Screenshot of nvidia-smi](../images/googlecolab-output-nvidia-smi.png) -## Run RAPIDS install script +### 4. Install RAPIDS on Colab + +You can install RAPIDS using + +1. pip +1. conda + +#### 4.1. Pip Checks GPU compatibility with RAPIDS, then installs the latest **stable** versions of RAPIDSAI's core libraries (cuDF, cuML, cuGraph, and xgboost) using `pip`. ```bash -# Colab warns and provides remediation steps if it's not compatible with RAPIDS. +# Colab warns and provides remediation steps if the GPUs is not compatible with RAPIDS. !git clone https://github.com/rapidsai/rapidsai-csp-utils.git !python rapidsai-csp-utils/colab/pip-install.py ``` -
+#### 4.2. Conda If you need to install any RAPIDS Extended libraries or the nightly version, you can use the [RAPIDS Conda Colab Template](https://colab.research.google.com/drive/1TAAi_szMfWqRfHVfjGSqnGVLr_ztzUM9) notebook and install via `conda`. -```bash -# The options are 'stable' and 'nightly'. Leaving it blank or adding any other words will default to 'stable'. +1. Create and run a cell with the code below to update Colab's gcc. Ignore all Colab alerts. -!python rapidsai-csp-utils/colab/env-check.py +```bash !bash rapidsai-csp-utils/colab/update_gcc.sh -!python rapidsai-csp-utils/colab/install_rapids.py +import os +os._exit(00) +``` + +1. Create and run a cell with the code below to install conda on Colab. Ignore all Colab alerts. + +```bash +import condacolab +condacolab.install() +``` + +[Optional] Run the test and conda install test cell. + +```bash +import condacolab +condacolab.check() +``` + +1. Before running the RAPIDS install cell, you can change the installation type between `stable` and `nightly`. All disclaimers around nightly installs apply. +1. Run the rest of the cells to complete the installation of RAPIDS on Colab. + +```bash +!python rapidsai-csp-utils/colab/install_rapids.py stable # example runs stable +import os +os.environ['NUMBAPRO_NVVM'] = '/usr/local/cuda/nvvm/lib64/libnvvm.so' +os.environ['NUMBAPRO_LIBDEVICE'] = '/usr/local/cuda/nvvm/libdevice/' +os.environ['CONDA_PREFIX'] = '/usr/local' ``` -## Test Rapids +### 5. Test Rapids ```python import cudf @@ -57,7 +138,7 @@ gdf ``` -## Next steps +### 6. Next steps Check out this [guide](https://towardsdatascience.com/) for an overview of how to access and work with your own datasets in Colab.