Skip to content

Commit

Permalink
docs: update w/ changes from main
Browse files Browse the repository at this point in the history
  • Loading branch information
Titus-von-Koeller committed Sep 27, 2024
1 parent 02d5b42 commit 6927dcc
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/source/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@

### Setup pre-commit hooks
- Install pre-commit hooks with `pip install pre-commit`.
- Run `pre-commit autoupdate` once to configure the hooks.
- Re-run `pre-commit autoupdate` every time a new hook got added.
- Run `pre-commit install` once to install the hooks, so they will be run on every commit.
- If the hooks introduce changes, they'll be visible with `git diff`. Review them and `git add` them if everything is fine, then re-execute the before commit, it should pass now.
- If you want to manually trigger the hooks, you may do `pre-commit run --all-files`

Now all the pre-commit hooks will be automatically run when you try to commit and if they introduce some changes, you need to re-add the changed files before being able to commit and push.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/YOUR_USERNAME/local/cuda-11.7
## Multi-backend[[multi-backend]]

> [!TIP]
> This functionality is currently in preview and therefore not yet production-ready!
> This functionality is currently in preview and therefore not yet production-ready! Please reference [this guide](./non_cuda_backends) for more in-depth information about the different backends and their current status.
Please follow these steps to install bitsandbytes with device-specific backend support other than CUDA:

Expand Down
16 changes: 15 additions & 1 deletion docs/source/non_cuda_backends.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,18 @@ Thank you for your support!

### Intel

### AMD
The following performance data is collected from Intel 4th Gen Xeon (SPR) platform. The tables show speed-up and memory compared with different data types of [Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf).

#### Inference (CPU)

| Data Type | BF16 | INT8 | NF4 | FP4 |
|---|---|---|---|---|
| Speed-Up (vs BF16) | 1.0x | 0.6x | 2.3x | 0.03x |
| Memory (GB) | 13.1 | 7.6 | 5.0 | 4.6 |

#### Fine-Tuning (CPU)

| Data Type | AMP BF16 | INT8 | NF4 | FP4 |
|---|---|---|---|---|
| Speed-Up (vs AMP BF16) | 1.0x | 0.38x | 0.07x | 0.07x |
| Memory (GB) | 40 | 9 | 6.6 | 6.6 |

0 comments on commit 6927dcc

Please sign in to comment.