Skip to content

Commit 198d08f

Browse files
Documentation Cleanup (#1644)
* Start cleaning up docs * Remove page * Minor update * correction * Minor doc revisions * Update installation.mdx * Update _toctree.yml
1 parent 9f85829 commit 198d08f

File tree

7 files changed

+73
-235
lines changed

7 files changed

+73
-235
lines changed

docs/source/_toctree.yml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@
22
sections:
33
- local: index
44
title: bitsandbytes
5-
- local: quickstart
6-
title: Quickstart
75
- local: installation
86
title: Installation
9-
- title: Guides
7+
- local: quickstart
8+
title: Quickstart
9+
10+
- title: Usage Guides
1011
sections:
1112
- local: optimizers
1213
title: 8-bit optimizers
13-
- local: algorithms
14-
title: Algorithms
15-
- local: non_cuda_backends
16-
title: Non-CUDA compute backends
1714
- local: fsdp_qlora
1815
title: FSDP-QLoRA
1916
- local: integrations
@@ -56,7 +53,7 @@
5653
title: RMSprop
5754
- local: reference/optim/sgd
5855
title: SGD
59-
- title: k-bit quantizers
56+
- title: Modules
6057
sections:
6158
- local: reference/nn/linear8bit
6259
title: LLM.int8()

docs/source/algorithms.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/source/contributing.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# Contributors guidelines
2-
... still under construction ... (feel free to propose materials, `bitsandbytes` is a community project)
1+
# Contribution Guide
32

43
## Setup
54

docs/source/faqs.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@
33
Please submit your questions in [this Github Discussion thread](https://github.com/bitsandbytes-foundation/bitsandbytes/discussions/1013) if you feel that they will likely affect a lot of other users and that they haven't been sufficiently covered in the documentation.
44

55
We'll pick the most generally applicable ones and post the QAs here or integrate them into the general documentation (also feel free to submit doc PRs, please).
6-
7-
# ... under construction ...

docs/source/installation.mdx

Lines changed: 67 additions & 162 deletions
Large diffs are not rendered by default.

docs/source/non_cuda_backends.mdx

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/source/reference/functional.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ The `bitsandbytes.functional` API provides the low-level building blocks for the
99
* For experimental or research purposes requiring non-standard quantization or performance optimizations.
1010

1111
## LLM.int8()
12-
[[autodoc]] functional.int8_double_quant
13-
1412
[[autodoc]] functional.int8_linear_matmul
1513

1614
[[autodoc]] functional.int8_mm_dequant
@@ -19,7 +17,6 @@ The `bitsandbytes.functional` API provides the low-level building blocks for the
1917

2018
[[autodoc]] functional.int8_vectorwise_quant
2119

22-
2320
## 4-bit
2421
[[autodoc]] functional.dequantize_4bit
2522

@@ -49,5 +46,3 @@ For more details see [8-Bit Approximations for Parallelism in Deep Learning](htt
4946

5047
## Utility
5148
[[autodoc]] functional.get_ptr
52-
53-
[[autodoc]] functional.is_on_gpu

0 commit comments

Comments
 (0)