From 88ab630315d9a79973302182d79653b1dfa0918a Mon Sep 17 00:00:00 2001 From: Rickard Date: Tue, 6 Feb 2024 22:13:09 +0100 Subject: [PATCH] Update installation instructions (#1047) * Update installation instructions * Update docs/source/installation.mdx Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com> * Update installation.mdx * Update docs/source/installation.mdx Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com> * Update installation.mdx * Update installation.mdx --------- Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com> --- docs/source/installation.mdx | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/source/installation.mdx b/docs/source/installation.mdx index 26c63d374..af65a3c7f 100644 --- a/docs/source/installation.mdx +++ b/docs/source/installation.mdx @@ -21,12 +21,16 @@ pip install bitsandbytes ### From source +You need CMake and Python installed. For Linux, make sure to install a compiler (`apt install build-essential`, for example). + ```bash git clone https://github.com/TimDettmers/bitsandbytes.git && cd bitsandbytes/ -cmake -B build -DBUILD_CUDA=ON -S . +pip install -r requirements-dev.txt +cmake -DCOMPUTE_BACKEND=cuda -S . +make pip install . ``` -Note support for non-CUDA GPUs (e.g. AMD, Intel), is also coming soon. +Note support for non-CUDA GPUs (e.g. AMD, Intel, Apple Silicon), is also coming soon. For a more detailed compilation guide, head to the [dedicated page on the topic](./compiling) @@ -34,12 +38,15 @@ For a more detailed compilation guide, head to the [dedicated page on the topic] ## Windows +Windows builds require Visual Studio with C++ support, as well as the Cuda SDK installed. + Currently for Windows users, you need to build bitsandbytes from source: ```bash git clone https://github.com/TimDettmers/bitsandbytes.git && cd bitsandbytes/ -cmake -B build -DBUILD_CUDA=ON -S . -cmake --build build --config Release +pip install -r requirements-dev.txt +cmake -DCOMPUTE_BACKEND=cuda -S . +cmake --build . --config Release python -m build --wheel ```