cleanup docs-build breaking install instructs#1244
Merged
Titus-von-Koeller merged 4 commits intobitsandbytes-foundation:multi-backend-refactorfrom Jun 21, 2024
Conversation
|
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. |
a51863e to
51fa778
Compare
51fa778 to
5b850bf
Compare
Collaborator
Author
Collaborator
Author
We should include a pointer avoiding this pitfall as well. |
Merged
stevhliu
reviewed
Jun 6, 2024
Contributor
stevhliu
left a comment
There was a problem hiding this comment.
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
Contributor
|
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
193120d
into
bitsandbytes-foundation:multi-backend-refactor
Collaborator
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-refactorbranch. 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