Create Docs for Liger-Kernel (#485)

## Summary Fixes #64 Instead of using Sphinx which I found to be cumbersome to set-up and iterate upon, I have created the docs using Material for Markdown, which uses markdown files for pages and does not change the original markdown files to a greater extent. To preview in your local system: run make serve in the terminal. To build pages: run make build in the terminal. Index page: ![image](https://github.com/user-attachments/assets/84f4218a-6cae-4020-9e8b-5acacd2d7ca3) Examples page: ![image](https://github.com/user-attachments/assets/a5bc80c9-70f2-48d9-a5f6-75f9c9fafbd9) Please let me know if any styling or further corrections are needed and I will make the necessary changes. cc: @ByronHsu
linkedin · Jan 22, 2025 · 38aac93 · 38aac93
1 parent 2ea3cfb
commit 38aac93
Show file tree

Hide file tree

Showing 11 changed files with 789 additions and 48 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,28 @@
+name: Publish documentation
+on:
+  push:
+    branches:
+      - gh-pages
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: test checkstyle test-convergence all
+.PHONY: test checkstyle test-convergence all serve build clean
 
 
 all: checkstyle test test-convergence
@@ -7,8 +7,7 @@ all: checkstyle test test-convergence
 test:
 	python -m pytest --disable-warnings test/ --ignore=test/convergence
 
-# Command to run flake8 (code style check), isort (import ordering), and black (code formatting)
-# Subsequent commands still run if the previous fails, but return failure at the end
+# Command to run ruff for linting and formatting code
 checkstyle:
 	ruff check . --fix; ruff_check_status=$$?; \
 	ruff format .; ruff_format_status=$$?; \
@@ -39,3 +38,17 @@ run-benchmarks:
 			python $$script; \
 		fi; \
 	done
+
+# MkDocs Configuration
+MKDOCS = mkdocs
+CONFIG_FILE = mkdocs.yml
+
+# MkDocs targets
+serve:
+	$(MKDOCS) serve -f $(CONFIG_FILE)
+
+build:
+	$(MKDOCS) build -f $(CONFIG_FILE)
+
+clean:
+	rm -rf site/
diff --git a/docs/Examples.md b/docs/Examples.md
@@ -0,0 +1,268 @@
+
+!!! Example "HANDS-ON USECASE EXAMPLES"
+| **Use Case**                                    | **Description**                                                                                   |
+|------------------------------------------------|---------------------------------------------------------------------------------------------------|
+| [**Hugging Face Trainer**](https://github.com/linkedin/Liger-Kernel/tree/main/examples/huggingface)      | Train LLaMA 3-8B ~20% faster with over 40% memory reduction on Alpaca dataset using 4 A100s with FSDP |
+| [**Lightning Trainer**](https://github.com/linkedin/Liger-Kernel/tree/main/examples/lightning)         | Increase 15% throughput and reduce memory usage by 40% with LLaMA3-8B on MMLU dataset using 8 A100s with DeepSpeed ZeRO3 |
+| [**Medusa Multi-head LLM (Retraining Phase)**](https://github.com/linkedin/Liger-Kernel/tree/main/examples/medusa)        | Reduce memory usage by 80% with 5 LM heads and improve throughput by 40% using 8 A100s with FSDP |
+| [**Vision-Language Model SFT**](https://github.com/linkedin/Liger-Kernel/tree/main/examples/huggingface/run_qwen2_vl.sh)      | Finetune Qwen2-VL on image-text data using 4 A100s with FSDP |
+| [**Liger ORPO Trainer**](https://github.com/linkedin/Liger-Kernel/blob/main/examples/alignment/run_orpo.py)      | Align Llama 3.2 using Liger ORPO Trainer with FSDP with 50% memory reduction |
+
+## HuggingFace Trainer
+
+### How to Run
+
+#### Locally on a GPU machine
+You can run the example locally on a GPU machine. The default hyperparameters and configurations work on single node with 4xA100 80GB GPUs and FSDP.
+
+!!! Example
+
+```bash
+pip install -r requirements.txt
+sh run_{MODEL}.sh
+```
+
+#### Remotely on Modal
+If you do not have access to a GPU machine, you can run the example on Modal. Modal is a serverless platform that allows you to run your code on a remote GPU machine. You can sign up for a free account at [Modal](https://www.modal.com/).
+
+!!! Example
+
+```bash
+pip install modal
+modal setup  # authenticate with Modal
+modal run launch_on_modal.py --script "run_qwen2_vl.sh"
+```
+
+!!! Notes
+
+1. This example uses an optional `use_liger` flag. If true, it does a 1 line monkey patch to apply liger kernel.
+
+2. The example uses Llama3 model that requires community license agreement and HuggingFace Hub login. If you want to use Llama3 in this example, please make sure you have done the following:
+    * Agree on the [community license agreement](https://huggingface.co/meta-llama/Meta-Llama-3-8B) .
+    * Run `huggingface-cli login` and enter your HuggingFace token.
+
+3. The default hyperparameters and configurations work on single node with 4xA100 80GB GPUs. For running on device with less GPU RAM, please consider reducing the per-GPU batch size and/or enable `CPUOffload` in FSDP.
+
+
+### Benchmark Result
+
+### Llama
+
+!!! Info
+>Benchmark conditions: 
+>Model= LLaMA 3-8B,Datset= Alpaca, Max seq len = 512, Data Type = bf16, Optimizer = AdamW, Gradient Checkpointing = True, Distributed Strategy = FSDP1 on 4 A100s.
+
+Throughput improves by around 20%, while GPU memory usage drops by 40%. This allows you to train the model on smaller GPUs, use larger batch sizes, or handle longer sequence lengths without incurring additional costs.
+
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/llama_tps.png)
+![GPU Memory Allocated](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/llama_mem_alloc.png)
+
+### Qwen
+
+!!! Info
+>Benchmark conditions:
+>Model= Qwen2-7B, Dataset= Alpaca, Max seq len = 512, Data Type = bf16, Optimizer = AdamW, Gradient Checkpointing = True, Distributed Strategy = FSDP1 on 4 A100s.
+
+Throughput improves by around 10%, while GPU memory usage drops by 50%.
+
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/qwen_tps.png)
+![GPU Memory Allocated](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/qwen_mem_alloc.png)
+
+
+### Gemma 7B
+
+!!! Info
+>Benchmark conditions:
+> Model= Gemma-7B, Dataset= Alpaca, Max seq len = 512, Data Type = bf16, Optimizer = AdamW, Gradient Checkpointing = True, Distributed Strategy = FSDP1 on 4 A100s.
+
+Throughput improves by around 24%, while GPU memory usage drops by 33%.
+
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/gemma_7b_mem.png)
+![GPU Memory Allocated](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/huggingface/img/gemma_7b_tp.png)
+
+## Lightning Trainer
+
+### How to Run
+
+#### Locally on a GPU machine
+You can run the example locally on a GPU machine.
+
+!!! Example
+
+```bash
+pip install -r requirements.txt
+
+# For single L40 48GB GPU
+python training.py --model Qwen/Qwen2-0.5B-Instruct --num_gpu 1 --max_length 1024
+
+# For 8XA100 40GB
+python training.py --model meta-llama/Meta-Llama-3-8B --strategy deepspeed
+```
+
+!!! Notes
+
+1. The example uses Llama3 model that requires community license agreement and HuggingFace Hub login. If you want to use Llama3 in this example, please make sure you have done the following:
+    * Agree on the [community license agreement](https://huggingface.co/meta-llama/Meta-Llama-3-8B)
+    * Run `huggingface-cli login` and enter your HuggingFace token.
+
+2. The default hyperparameters and configurations for gemma works on single L40 48GB GPU and config for llama work on single node with 8xA100 40GB GPUs. For running on device with less GPU RAM, please consider reducing the per-GPU batch size and/or enable `CPUOffload` in FSDP.
+
+## Medusa
+
+Medusa is a simple framework that democratizes the acceleration techniques for LLM generation with multiple decoding heads. To know more, you can check out the [repo](https://arxiv.org/abs/2401.10774) and the [paper](https://arxiv.org/abs/2401.10774) .
+
+The Liger fused CE kernel is highly effective in this scenario, eliminating the need to materialize logits for each head, which usually consumes a large volume of memory due to the extensive vocabulary size (e.g., for LLaMA-3, the vocabulary size is 128k).
+
+The introduction of multiple heads can easily lead to OOM (Out of Memory) issues. However, thanks to the efficient Liger fused CE, which calculates the gradient in place and doesn't materialize the logits, we have observed very effective results. This efficiency opens up more opportunities for multi-token prediction research and development.
+
+
+### How to Run
+
+!!! Example
+
+```bash
+git clone [email protected]:linkedin/Liger-Kernel.git
+cd {PATH_TO_Liger-Kernel}/Liger-Kernel/
+pip install -e .
+cd {PATH_TO_Liger-Kernel}/Liger-Kernel/examples/medusa
+pip install -r requirements.txt
+sh scripts/llama3_8b_medusa.sh
+```
+
+!!! Notes
+
+1. This example uses an optional `use_liger` flag. If true, it does a monkey patch to apply liger kernel with medusa heads.
+
+2. The example uses Llama3 model that requires community license agreement and HuggingFace Hub login. If you want to use Llama3 in this example, please make sure you have done the followings:
+    * Agree on the community license agreement https://huggingface.co/meta-llama/Meta-Llama-3-8B
+    * Run `huggingface-cli login` and enter your HuggingFace token
+
+3. The default hyperparameters and configurations work on single node with 8xA100 GPUs. For running on device with less GPU RAM, please consider reducing the per-GPU batch size and/or enable `CPUOffload` in FSDP.
+
+4. We are using a smaller sample of shared GPT data primarily to benchmark performance. The example requires hyperparameter tuning and dataset selection to work effectively, also ensuring the dataset has the same distribution as the LLaMA pretraining data. Welcome contribution to enhance the example code.
+
+### Benchmark Result
+
+!!! Info
+> 1. Benchmark conditions: LLaMA 3-8B, Batch Size = 6, Data Type = bf16, Optimizer = AdamW, Gradient Checkpointing = True, Distributed Strategy = FSDP1 on 8 A100s.
+
+#### Stage 1
+
+Stage 1 refers to Medusa-1 where the backbone model is frozen and only weights of LLM heads are updated.
+
+!!! Warning
+```bash
+# Modify this flag in llama3_8b_medusa.sh to True enables stage1 
+--medusa_only_heads True
+```
+
+#### num_head = 3
+
+![Memory](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Memory_Stage1_num_head_3.png)
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Throughput_Stage1_num_head_3.png)
+
+#### num_head = 5
+
+![Memory](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Memory_Stage1_num_head_5.png)
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Throughput_Stage1_num_head_5.png)
+
+#### Stage 2
+
+!!! Warning
+```bash
+# Modify this flag to False in llama3_8b_medusa.sh enables stage2
+--medusa_only_heads False
+```
+
+Stage 2 refers to Medusa-2 where all the model weights are updated including the backbone model and llm heads.
+
+#### num_head = 3
+
+![Memory](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Memory_Stage2_num_head_3.png)
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Throughput_Stage2_num_head_3.png)
+
+#### num_head = 5
+
+![Memory](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Memory_Stage2_num_head_5.png)
+![Throughput](https://raw.githubusercontent.com/linkedin/Liger-Kernel/main/examples/medusa/docs/images/Throughput_Stage2_num_head_5.png)
+
+
+## Vision-Language Model SFT
+
+## How to Run
+
+### Locally on a GPU Machine
+You can run the example locally on a GPU machine. The default hyperparameters and configurations work on single node with 4xA100 80GB GPUs.
+
+!!! Example
+```bash
+#!/bin/bash
+
+torchrun --nnodes=1 --nproc-per-node=4 training_multimodal.py \
+    --model_name "Qwen/Qwen2-VL-7B-Instruct" \
+    --bf16 \
+    --num_train_epochs 1 \
+    --per_device_train_batch_size 8 \
+    --per_device_eval_batch_size 8 \
+    --eval_strategy "no" \
+    --save_strategy "no" \
+    --learning_rate 6e-6 \
+    --weight_decay 0.05 \
+    --warmup_ratio 0.1 \
+    --lr_scheduler_type "cosine" \
+    --logging_steps 1 \
+    --include_num_input_tokens_seen \
+    --report_to none \
+    --fsdp "full_shard auto_wrap" \
+    --fsdp_config config/fsdp_config.json \
+    --seed 42 \
+    --use_liger True \
+    --output_dir multimodal_finetuning
+```
+
+## ORPO Trainer
+
+### How to Run
+
+#### Locally on a GPU Machine
+
+You can run the example locally on a GPU machine and FSDP.
+
+!!! Example
+```py
+import torch
+from datasets import load_dataset
+from transformers import AutoModelForCausalLM, AutoTokenizer
+from trl import ORPOConfig  # noqa: F401
+
+from liger_kernel.transformers.trainer import LigerORPOTrainer  # noqa: F401
+
+model = AutoModelForCausalLM.from_pretrained(
+    "meta-llama/Llama-3.2-1B-Instruct",
+    torch_dtype=torch.bfloat16,
+)
+
+tokenizer = AutoTokenizer.from_pretrained(
+    "meta-llama/Llama-3.2-1B-Instruct",
+    max_length=512,
+    padding="max_length",
+)
+tokenizer.pad_token = tokenizer.eos_token
+
+train_dataset = load_dataset("trl-lib/tldr-preference", split="train")
+
+training_args = ORPOConfig(
+    output_dir="Llama3.2_1B_Instruct",
+    beta=0.1,
+    max_length=128,
+    per_device_train_batch_size=32,
+    max_steps=100,
+    save_strategy="no",
+)
+
+trainer = LigerORPOTrainer(
+    model=model, args=training_args, tokenizer=tokenizer, train_dataset=train_dataset
+)
+
+trainer.train()
+```
diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md
@@ -0,0 +1,64 @@
+There are a couple of ways to apply Liger kernels, depending on the level of customization required.
+
+### 1. Use AutoLigerKernelForCausalLM
+
+Using the `AutoLigerKernelForCausalLM` is the simplest approach, as you don't have to import a model-specific patching API. If the model type is supported, the modeling code will be automatically patched using the default settings.
+
+!!! Example
+
+  ```python
+  from liger_kernel.transformers import AutoLigerKernelForCausalLM
+
+  # This AutoModel wrapper class automatically monkey-patches the
+  # model with the optimized Liger kernels if the model is supported.
+  model = AutoLigerKernelForCausalLM.from_pretrained("path/to/some/model")
+  ```
+
+### 2. Apply Model-Specific Patching APIs
+
+Using the [patching APIs](https://github.com/linkedin/Liger-Kernel?tab=readme-ov-file#patching), you can swap Hugging Face models with optimized Liger Kernels.
+
+!!! Example
+
+```python
+import transformers
+from liger_kernel.transformers import apply_liger_kernel_to_llama
+
+# 1a. Adding this line automatically monkey-patches the model with the optimized Liger kernels
+apply_liger_kernel_to_llama()
+
+# 1b. You could alternatively specify exactly which kernels are applied
+apply_liger_kernel_to_llama(
+  rope=True,
+  swiglu=True,
+  cross_entropy=True,
+  fused_linear_cross_entropy=False,
+  rms_norm=False
+)
+
+# 2. Instantiate patched model
+model = transformers.AutoModelForCausalLM("path/to/llama/model")
+```
+
+### 3. Compose Your Own Model
+
+You can take individual [kernels](https://github.com/linkedin/Liger-Kernel?tab=readme-ov-file#model-kernels) to compose your models.
+
+!!! Example
+
+```python
+from liger_kernel.transformers import LigerFusedLinearCrossEntropyLoss
+import torch.nn as nn
+import torch
+
+model = nn.Linear(128, 256).cuda()
+
+# fuses linear + cross entropy layers together and performs chunk-by-chunk computation to reduce memory
+loss_fn = LigerFusedLinearCrossEntropyLoss()
+
+input = torch.randn(4, 128, requires_grad=True, device="cuda")
+target = torch.randint(256, (4, ), device="cuda")
+
+loss = loss_fn(model.weight, input, target)
+loss.backward()
+```