Skip to content

Conversation

@Titus-von-Koeller
Copy link
Collaborator

Hey @pnunna93, there was this stray docs file from 4 weeks ago that was breaking our docs build on any PR to the multi-backend-refactor branch. I'll have to remove it, but I think we should add a section on how to compile things correctly asap.

For now, I just cleaned up the docs that you added 4 weeks back (without including them in the TOC; that's why they broke the build), but maybe we should combine that with some parts from here?

@stevhliu What do you think about how to best place this and how to account for the matrix of possibilities between OS and different backends, e.g. Windows build from source is currently slightly different. All backends should also support Windows, unless it's an OS specific backend, like MPS.

On another note, I'm planning to include an easy installation path for the alpha release and then announce it on socials, to get he maximum of alpha/beta testers involved for early feedback.

I'm currently working on the following functionality to install the wheel directly from the Github artifact of our per-commit wheel build, e.g. curl https://raw.githubusercontent.com/timdettmers/bitsandbytes/main/scripts/install-nightly-bnb.py | python -. That way people don't have to deal with the hassle of compiling.

@pnunna93 We aren't yet building AMD specific wheels, right? Maybe you could task someone on your team with that?

Long-term, I would like to people to install with pip install bitsandbytes[rocm] but for now maybe we just bundle everything together in the default bnb wheel?

cc @younesbelkada cc @matthewdouglas

@github-actions
Copy link

github-actions bot commented Jun 6, 2024

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@Titus-von-Koeller Titus-von-Koeller force-pushed the multi-backend-installation-instructions branch from a51863e to 51fa778 Compare June 6, 2024 10:33
@Titus-von-Koeller Titus-von-Koeller force-pushed the multi-backend-installation-instructions branch from 51fa778 to 5b850bf Compare June 6, 2024 10:41
@Titus-von-Koeller
Copy link
Collaborator Author

@pnunna93 @stevhliu feel free to propose changes or do a PR to my PR. Would be great if we could move relatively quickly on this, as things are converging towards an official communication for the alpha release (hopefully tmr or early next week)

@Titus-von-Koeller
Copy link
Collaborator Author

The torch version is for rocm6.0. Please reinstall 6.1 torch and build bitsandbytes again:
pip3 install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.1/

We should include a pointer avoiding this pitfall as well.

Copy link
Collaborator

@younesbelkada younesbelkada left a comment

Choose a reason for hiding this comment

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

Thanks a lot !

Copy link
Contributor

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Maybe you can break it down by backend > OS? I think it's easier for users to identify their backend first and then OS next. Perhaps something like:

# Installation

bitsandbytes provides broad backend support for CUDA, AMD ROCm, Intel CPU/GPUs, and Apple silicon.

## CUDA
### Compile from source
### PyTorch CUDA versions

## AMD ROCm
install instructions for Linux/Windows
include pointer for rocm pitfall here
## Intel CPU + GPU
install instructions for Linux/Windows
## Apple Silicon (MPS)
install instructions for Linux/Windows

@pnunna93
Copy link
Contributor

pnunna93 commented Jun 7, 2024

I have opened a PR here to update ROCm installation steps - Titus-von-Koeller#3

It includes changes mentioned in this thread.

Update install instructions for ROCm
@Titus-von-Koeller Titus-von-Koeller changed the base branch from multi-backend-refactor to main June 21, 2024 16:40
@Titus-von-Koeller Titus-von-Koeller changed the base branch from main to multi-backend-refactor June 21, 2024 16:40
@Titus-von-Koeller Titus-von-Koeller merged commit 193120d into bitsandbytes-foundation:multi-backend-refactor Jun 21, 2024
@Titus-von-Koeller
Copy link
Collaborator Author

LGTM, thanks @pnunna93 and @stevhliu ❤️!

@pnunna93 pnunna93 mentioned this pull request Jul 8, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants