From b4f7c4ebd9dabc7c3dca911fa184619e775e01d4 Mon Sep 17 00:00:00 2001 From: Steven Liu Date: Tue, 26 Mar 2024 12:27:05 -0700 Subject: [PATCH 1/2] split build from source off --- docs/source/installation.mdx | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/source/installation.mdx b/docs/source/installation.mdx index 49d8b4ebd..be70080d5 100644 --- a/docs/source/installation.mdx +++ b/docs/source/installation.mdx @@ -1,9 +1,9 @@ # Installation -bitsandbytes is only supported on CUDA GPUs for CUDA versions **11.0 - 12.3**. Select your operating system below to see the installation instructions. +bitsandbytes is only supported on CUDA GPUs for CUDA versions **11.0 - 12.3**. - - +> [!TIP] +> MacOS support is still a work in progress! Subscribe to this [issue](https://github.com/TimDettmers/bitsandbytes/issues/1020) to get notified about discussions and to track the integration progress. For Linux systems, make sure your hardware meets the following requirements to use bitsandbytes features. @@ -23,6 +23,11 @@ pip install bitsandbytes ## Compile from source +For Linux and Windows systems, you can compile bitsandbytes from source. Installing from source allows for more build options with different CMake configurations. + + + + To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. Make sure you have a compiler installed to compile C++ (gcc, make, headers, etc.). For example, to install a compiler and CMake on Ubuntu: ```bash @@ -49,7 +54,7 @@ pip install . Windows systems require Visual Studio with C++ support as well as an installation of the CUDA SDK. -You'll need to build bitsandbytes from source. To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. You should also install CUDA Toolkit by following the [CUDA Installation Guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) guide from NVIDIA. +To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. You should also install CUDA Toolkit by following the [CUDA Installation Guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) guide from NVIDIA. ```bash git clone https://github.com/TimDettmers/bitsandbytes.git && cd bitsandbytes/ @@ -61,12 +66,6 @@ python -m build --wheel Big thanks to [wkpark](https://github.com/wkpark), [Jamezo97](https://github.com/Jamezo97), [rickardp](https://github.com/rickardp), [akx](https://github.com/akx) for their amazing contributions to make bitsandbytes compatible with Windows. - - - -> [!TIP] -> MacOS support is still a work in progress! Subscribe to this [issue](https://github.com/TimDettmers/bitsandbytes/issues/1020) to get notified about discussions and to track the integration progress. - From 0f97e2c5ddb375030c8c557133a49733ec511742 Mon Sep 17 00:00:00 2001 From: Steven Liu Date: Mon, 8 Apr 2024 11:52:17 -0700 Subject: [PATCH 2/2] validated compilers --- docs/source/installation.mdx | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/source/installation.mdx b/docs/source/installation.mdx index be70080d5..89c21e04b 100644 --- a/docs/source/installation.mdx +++ b/docs/source/installation.mdx @@ -2,6 +2,14 @@ bitsandbytes is only supported on CUDA GPUs for CUDA versions **11.0 - 12.3**. +The latest version of bitsandbytes (v0.43.0) builds on: + +| OS | CUDA | Compiler | +|---|---|---| +| Linux | 11.7 - 12.3 | GCC 11.4 | +| | 12.4+ | GCC 13.2 | +| Windows | 11.7 - 12.4 | MSVC 19.38+ (VS2022 17.8.0+) | + > [!TIP] > MacOS support is still a work in progress! Subscribe to this [issue](https://github.com/TimDettmers/bitsandbytes/issues/1020) to get notified about discussions and to track the integration progress. @@ -34,7 +42,15 @@ To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** insta apt-get install -y build-essential cmake ``` -You should also install CUDA Toolkit by following the [NVIDIA CUDA Installation Guide for Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) guide from NVIDIA. +You should also install CUDA Toolkit by following the [NVIDIA CUDA Installation Guide for Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) guide from NVIDIA. The current expected CUDA Toolkit version is **11.1+** and it is recommended to install **GCC >= 7.3** and required to have at least **GCC >= 6**. + +Refer to the following table if you're using another CUDA Toolkit version. + +| CUDA Toolkit | GCC | +|---|---| +| >= 11.4.1 | >= 11 | +| >= 12.0 | >= 12 | +| >= 12.4 | >= 13 | Now to install the bitsandbytes package from source, run the following commands: @@ -56,6 +72,12 @@ Windows systems require Visual Studio with C++ support as well as an installatio To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. You should also install CUDA Toolkit by following the [CUDA Installation Guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) guide from NVIDIA. +Refer to the following table if you're using another CUDA Toolkit version. + +| CUDA Toolkit | MSVC | +|---|---| +| >= 11.6 | 19.30+ (VS2022) | + ```bash git clone https://github.com/TimDettmers/bitsandbytes.git && cd bitsandbytes/ pip install -r requirements-dev.txt