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.
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.
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
documentation release v1 #1012
documentation release v1 #1012
Changes from 11 commits
fbc0385
84b5fc0
725d29a
58566e2
47cc3e9
c26645b
ab42c5f
a71efa8
c1ec5f8
544114d
f735b35
daff94c
301ee80
683a72b
60a7699
543a7b1
2d73f4d
8f0fd8a
a3c45d3
b370cee
fd64f21
38d323a
82485d0
75cfb1c
7a71390
a84afcf
d3709f4
e00cbc9
8a67759
d632531
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here we point out to relevant doc sections in transformers / peft / Trainer + very briefly explain how these are integrated:
e.g. for transformers state that you can load any model in 8-bit / 4-bit precision, for PEFT, you can use QLoRA out of the box with
LoraConfig
+ 4-bit base model, for Trainer: all bnb optimizers are supported by passing the correct string inTrainingArguments
: https://github.com/huggingface/transformers/blob/abbffc4525566a48a9733639797c812301218b83/src/transformers/training_args.py#L134Few references:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file should stay as
index.mdx
and be referred as the first page / index page that briefly presents what bitsandbytes is, in one paragraph & lists the available documentation sections (quickstart, quantization, optimizers, integrations, resources)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this and below should be completely removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, deleted everything from here on down
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even though this part here below is still relevant, maybe? Wdyt?
Features
I think the standalone algs are worth documenting, but maybe we make a note of that for later and leave it out completely for now. Or do you think it's better to leave a placeholder and put a comment encouraging community contributions? I think it makes sense to leverage the community as much as possible for docs and doc-strings
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this file really needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm, I took this from some docs that I found from before. But you're right, it's a bit obvious. I thought it could eventually be formed into some walkthrough of the library. But I agree that it doesn't add any value the way it is now and I agree that we should remove it. I'll delete.