_toctree.yml 1.5 KB
Newer Older
Titus's avatar
Titus committed
1
2
- title: Get started
  sections:
Titus's avatar
Titus committed
3
  - local: index
Steven Liu's avatar
Steven Liu committed
4
    title: bitsandbytes
Titus's avatar
Titus committed
5
6
  - local: installation
    title: Installation
7
8
9
10
  - local: quickstart
    title: Quickstart

- title: Usage Guides
Titus's avatar
Titus committed
11
12
  sections:
  - local: optimizers
Steven Liu's avatar
Steven Liu committed
13
    title: 8-bit optimizers
Steven Liu's avatar
toctree  
Steven Liu committed
14
15
  - local: fsdp_qlora
    title: FSDP-QLoRA
Steven Liu's avatar
Steven Liu committed
16
17
18
19
20
21
22
23
24
  - local: integrations
    title: Integrations
  - local: errors
    title: Troubleshoot
  - local: contributing
    title: Contribute
  - local: faqs
    title: FAQs
- title: Explanation
Titus's avatar
Titus committed
25
  sections:
26
27
28
  - local: explanations/optimizers
    title: 8-bit optimizers
  - local: explanations/resources
Titus's avatar
Titus committed
29
    title: Papers, resources & how to cite
Steven Liu's avatar
Steven Liu committed
30
- title: API reference
Titus's avatar
Titus committed
31
  sections:
32
33
  - title: Functional
    local: reference/functional
Steven Liu's avatar
Steven Liu committed
34
35
36
37
38
39
40
41
42
43
  - title: Optimizers
    sections:
    - local: reference/optim/optim_overview
      title: Overview
    - local: reference/optim/adagrad
      title: AdaGrad
    - local: reference/optim/adam
      title: Adam
    - local: reference/optim/adamw
      title: AdamW
44
45
    - local: reference/optim/ademamix
      title: AdEMAMix
Steven Liu's avatar
Steven Liu committed
46
47
48
49
50
51
52
53
54
55
    - local: reference/optim/lamb
      title: LAMB
    - local: reference/optim/lars
      title: LARS
    - local: reference/optim/lion
      title: Lion
    - local: reference/optim/rmsprop
      title: RMSprop
    - local: reference/optim/sgd
      title: SGD
56
  - title: Modules
Steven Liu's avatar
Steven Liu committed
57
58
    sections:
    - local: reference/nn/linear8bit
59
      title: LLM.int8()
Steven Liu's avatar
Steven Liu committed
60
61
62
63
    - local: reference/nn/linear4bit
      title: 4-bit quantizer
    - local: reference/nn/embeddings
      title: Embedding