LLaMA-Factory Document

Document for https://github.com/hiyouga/LLaMA-Factory

Visit https://llamafactory.readthedocs.io/ for the document.

Contribution

Doc contribution welcome. Before creating a PR, please check and test your docs locally as follows:

1. Step into the path docs:

cd docs

2. Install the required dependencies:

pip install -r requirements.txt

3. Build

make html

4. Server on localhost for doc preview:

python -m http.server -d build/html 8008

Translation

For translation, you can refer to the format of example to translate the documents into English. After completing the translation, you can run the command:

# LLaMA-Factory-Doc/docs
sphinx-build -b html -D language=en ./source/ build/html/en

to build HTML from the .po files.

You can preview the corresponding HTML files in LLaMA-Factory-Doc/docs/build/html/en before updating.

Acknowledgement

This repo benefits from Qwen2. Thanks for their wonderful works.