Skip to content

Documentation Cleanup #1644

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions docs/source/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,15 @@
sections:
- local: index
title: bitsandbytes
- local: quickstart
title: Quickstart
- local: installation
title: Installation
- title: Guides
- local: quickstart
title: Quickstart

- title: Usage Guides
sections:
- local: optimizers
title: 8-bit optimizers
- local: algorithms
title: Algorithms
- local: non_cuda_backends
title: Non-CUDA compute backends
- local: fsdp_qlora
title: FSDP-QLoRA
- local: integrations
Expand Down Expand Up @@ -56,7 +53,7 @@
title: RMSprop
- local: reference/optim/sgd
title: SGD
- title: k-bit quantizers
- title: Modules
sections:
- local: reference/nn/linear8bit
title: LLM.int8()
Expand Down
12 changes: 0 additions & 12 deletions docs/source/algorithms.mdx

This file was deleted.

3 changes: 1 addition & 2 deletions docs/source/contributing.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Contributors guidelines
... still under construction ... (feel free to propose materials, `bitsandbytes` is a community project)
# Contribution Guide

## Setup

Expand Down
2 changes: 0 additions & 2 deletions docs/source/faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@
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.

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).

# ... under construction ...
229 changes: 67 additions & 162 deletions docs/source/installation.mdx

Large diffs are not rendered by default.

44 changes: 0 additions & 44 deletions docs/source/non_cuda_backends.mdx

This file was deleted.

5 changes: 0 additions & 5 deletions docs/source/reference/functional.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ The `bitsandbytes.functional` API provides the low-level building blocks for the
* For experimental or research purposes requiring non-standard quantization or performance optimizations.

## LLM.int8()
[[autodoc]] functional.int8_double_quant

[[autodoc]] functional.int8_linear_matmul

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

[[autodoc]] functional.int8_vectorwise_quant


## 4-bit
[[autodoc]] functional.dequantize_4bit

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

## Utility
[[autodoc]] functional.get_ptr

[[autodoc]] functional.is_on_gpu