Skip to content

Commit

Permalink
Update installation instructions (#1047)
Browse files Browse the repository at this point in the history
* Update installation instructions

* Update docs/source/installation.mdx

Co-authored-by: Younes Belkada <[email protected]>

* Update installation.mdx

* Update docs/source/installation.mdx

Co-authored-by: Younes Belkada <[email protected]>

* Update installation.mdx

* Update installation.mdx

---------

Co-authored-by: Younes Belkada <[email protected]>
  • Loading branch information
rickardp and younesbelkada authored Feb 6, 2024
1 parent 6e0f84d commit 88ab630
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/source/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,32 @@ 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)

</hfoption>
<hfoption id="Windows">

## 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
```

Expand Down

0 comments on commit 88ab630

Please sign in to comment.