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.

Sign up for GitHub

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

Update installation instructions #1047

Merged
merged 6 commits into from
Feb 6, 2024
Merged

Update installation instructions #1047

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f26df5
Update installation instructions
rickardp Feb 6, 2024
d9543c2
Update docs/source/installation.mdx
rickardp Feb 6, 2024
7b50e4d
Update installation.mdx
rickardp Feb 6, 2024
5ae133f
Update docs/source/installation.mdx
rickardp Feb 6, 2024
bd219a0
Update installation.mdx
rickardp Feb 6, 2024
16cf29a
Update installation.mdx
rickardp Feb 6, 2024
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
15 changes: 11 additions & 4 deletions docs/source/installation.mdx
View file
Open in desktop
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
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
python -m build --wheel
pip install .

For consistency with above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I left it as it is since I can't verify this. Can someone with access to a windows VM double check these?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah yes good point - cc @wkpark 🙏

Copy link
Member

@matthewdouglas matthewdouglas Feb 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

This works for me with pip install ..

Alternatively with building the wheel, this also works:

python -m build --wheel
pip install dist/bitsandbytes-0.43.0.dev0-cp311-cp311-win_amd64.whl

```

Expand Down
Loading