Feat(doc): Reorganize documentation, fix broken syntax, update notes (#2348)

* feat(doc): organize docs, add to menu bar, fix broken formatting

* feat: add link to custom integrations

* feat: update readme for integrations to include citations and repo link

* chore: update lm_eval info

* chore: use fullname

* Update docs/cli.qmd per suggestion

Co-authored-by: Dan Saunders <danjsaund@gmail.com>

* feat: add sweep doc

* feat: add kd doc

* fix: remove toc

* fix: update deprecation

* feat: add more info about chat_template issues

* fix: heading level

* fix: shell->bash code block

* fix: ray link

* fix(doc): heading level, header links, formatting

* feat: add grpo docs

* feat: add style changes

* fix: wrong cli arg for lm-eval

* fix: remove old run method

* feat: load custom integration doc dynamically

* fix: remove old cli way

* fix: toc

* fix: minor formatting

---------

Co-authored-by: Dan Saunders <danjsaund@gmail.com>
This commit is contained in:
NanoCode012
2025-02-25 16:09:37 +07:00
committed by GitHub
parent 1110a37e21
commit 2efe1b4c09
32 changed files with 940 additions and 443 deletions

View File

@@ -1,5 +1,5 @@
---
title: "Getting Started with Axolotl"
title: "Quickstart"
format:
html:
toc: true
@@ -17,12 +17,12 @@ Let's start by fine-tuning a small language model using LoRA. This example uses
Assuming `axolotl` is installed (if not, see our [Installation Guide](installation.qmd))
1. Download example configs:
```shell
```bash
axolotl fetch examples
```
2. Run the training:
```shell
```bash
axolotl train examples/llama-3/lora-1b.yml
```
@@ -108,7 +108,7 @@ Please consult the supported [Dataset Formats](dataset-formats/) for more detail
3. Run the training:
```shell
```bash
axolotl train my_training.yml
```
@@ -118,7 +118,7 @@ axolotl train my_training.yml
After training, test your model:
```shell
```bash
axolotl inference my_training.yml --lora-model-dir="./outputs/lora-out"
```
@@ -126,7 +126,7 @@ axolotl inference my_training.yml --lora-model-dir="./outputs/lora-out"
For large datasets, preprocess first:
```shell
```bash
axolotl preprocess my_training.yml
```
@@ -134,7 +134,7 @@ axolotl preprocess my_training.yml
Launch a Gradio interface:
```shell
```bash
axolotl inference my_training.yml --lora-model-dir="./outputs/lora-out" --gradio
```