LlamaFactory

(β˜… 74,279)

Unified Efficient Fine-Tuning of 100+ LLMs & VLMs (ACL 2024)

  • .dockerignore
  • .env.local
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • CITATION.cff
  • CLAUDE.md
  • LICENSE
  • Makefile
  • MANIFEST.in
  • pyproject.toml
  • README.md
  • README_zh.md

# Installation Guide

1. Get the code
git clone https://github.com/hiyouga/LlamaFactory

Downloads the entire project code from GitHub to your computer.

cd LlamaFactory

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install "huggingface_hub<1.0.0"

Installs the package published on PyPI directly β€” no need to clone the source.

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126

Installs the package published on PyPI directly β€” no need to clone the source.

pip install bitsandbytes

Installs the package published on PyPI directly β€” no need to clone the source.

pip install https://github.com/jllllll/bitsandbytes-windows-webui/releases/download/wheels/bitsandbytes-0.41.2.post2-py3-none-win_amd64.whl

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -it --rm --gpus=all --ipc=host hiyouga/llamafactory:latest

Runs the built image as an actual container.

docker pull hiyouga/llamafactory:latest-910b-ubuntu

Type this command into your terminal and run it.

docker pull hiyouga/llamafactory:latest-a3-ubuntu

Type this command into your terminal and run it.

docker pull hiyouga/llamafactory:latest-910b-openeuler

Type this command into your terminal and run it.

docker pull hiyouga/llamafactory:latest-a3-openeuler

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install "huggingface_hub<1.0.0"

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

pip install -r requirements/metrics.txt

Installs the Python libraries listed in requirements.txt (or similar).

pip uninstall torch torchvision torchaudio

Type this command into your terminal and run it.

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation