diff --git a/.dockerignore b/.dockerignore
index bc56ab8b..a07ec860 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -3,12 +3,12 @@
.github
.venv
cache
-data
docker
saves
hf_cache
ms_cache
om_cache
+shared_data
output
.dockerignore
.gitattributes
diff --git a/.github/workflows/push_docker.yml b/.github/workflows/docker.yml
similarity index 85%
rename from .github/workflows/push_docker.yml
rename to .github/workflows/docker.yml
index d9189d5c..c3c38005 100644
--- a/.github/workflows/push_docker.yml
+++ b/.github/workflows/docker.yml
@@ -1,4 +1,4 @@
-name: push_docker
+name: docker
on:
workflow_dispatch:
@@ -32,7 +32,15 @@ jobs:
url: https://hub.docker.com/r/hiyouga/llamafactory
steps:
- - name: Checkout repository
+ - name: Free up disk space
+ run: |
+ df -h
+ sudo rm -rf /usr/share/dotnet
+ sudo rm -rf /opt/ghc
+ sudo rm -rf /opt/hostedtoolcache
+ df -h
+
+ - name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
diff --git a/README.md b/README.md
index b68ea1cb..e9a0cd3b 100644
--- a/README.md
+++ b/README.md
@@ -474,16 +474,25 @@ huggingface-cli login
> [!IMPORTANT]
> Installation is mandatory.
+#### Install from Source
+
```bash
git clone --depth 1 https://github.com/hiyouga/LLaMA-Factory.git
cd LLaMA-Factory
pip install -e ".[torch,metrics]" --no-build-isolation
```
-Extra dependencies available: torch, torch-npu, metrics, deepspeed, liger-kernel, bitsandbytes, hqq, eetq, gptq, aqlm, vllm, sglang, galore, apollo, badam, adam-mini, qwen, minicpm_v, modelscope, openmind, swanlab, quality
+Extra dependencies available: torch, torch-npu, metrics, deepspeed, liger-kernel, bitsandbytes, hqq, eetq, gptq, aqlm, vllm, sglang, galore, apollo, badam, adam-mini, qwen, minicpm_v, modelscope, openmind, swanlab, dev
-> [!TIP]
-> Use `pip install -e . --no-deps --no-build-isolation` to resolve package conflicts.
+#### Install from Docker Image
+
+```bash
+docker run -it --rm --gpus=all --ipc=host hiyouga/llamafactory:latest
+```
+
+Find the pre-built images: https://hub.docker.com/r/hiyouga/llamafactory/tags
+
+Please refer to [build docker](#build-docker) to build the image yourself.
Setting up a virtual environment with uv
@@ -671,7 +680,7 @@ docker run -dit --ipc=host --gpus=all \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-p 7860:7860 \
-p 8000:8000 \
@@ -686,14 +695,14 @@ For Ascend NPU users:
```bash
docker build -f ./docker/docker-npu/Dockerfile \
--build-arg PIP_INDEX=https://pypi.org/simple \
- --build-arg EXTRAS=metrics \
+ --build-arg EXTRAS=torch-npu,metrics \
-t llamafactory:latest .
docker run -dit --ipc=host \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-v /usr/local/dcmi:/usr/local/dcmi \
-v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
@@ -723,7 +732,7 @@ docker run -dit --ipc=host \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-p 7860:7860 \
-p 8000:8000 \
@@ -742,7 +751,7 @@ docker exec -it llamafactory bash
- `hf_cache`: Utilize Hugging Face cache on the host machine. Reassignable if a cache already exists in a different directory.
- `ms_cache`: Similar to Hugging Face cache but for ModelScope users.
- `om_cache`: Similar to Hugging Face cache but for Modelers users.
-- `data`: Place datasets on this dir of the host machine so that they can be selected on LLaMA Board GUI.
+- `shared_data`: Place datasets on this dir of the host machine so that they can be selected on LLaMA Board GUI.
- `output`: Set export dir to this location so that the merged result can be accessed directly on the host machine.
使用 uv 构建虚拟环境
@@ -673,7 +682,7 @@ docker run -dit --ipc=host --gpus=all \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-p 7860:7860 \
-p 8000:8000 \
@@ -688,14 +697,14 @@ docker exec -it llamafactory bash
```bash
docker build -f ./docker/docker-npu/Dockerfile \
--build-arg PIP_INDEX=https://pypi.org/simple \
- --build-arg EXTRAS=metrics \
+ --build-arg EXTRAS=torch-npu,metrics \
-t llamafactory:latest .
docker run -dit --ipc=host \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-v /usr/local/dcmi:/usr/local/dcmi \
-v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
@@ -725,7 +734,7 @@ docker run -dit --ipc=host \
-v ./hf_cache:/root/.cache/huggingface \
-v ./ms_cache:/root/.cache/modelscope \
-v ./om_cache:/root/.cache/openmind \
- -v ./data:/app/data \
+ -v ./shared_data:/app/shared_data \
-v ./output:/app/output \
-p 7860:7860 \
-p 8000:8000 \
@@ -744,7 +753,7 @@ docker exec -it llamafactory bash
- `hf_cache`：使用宿主机的 Hugging Face 缓存文件夹，允许更改为新的目录。
- `ms_cache`：类似 Hugging Face 缓存文件夹，为 ModelScope 用户提供。
- `om_cache`：类似 Hugging Face 缓存文件夹，为 Modelers 用户提供。
-- `data`：宿主机中存放数据集的文件夹路径。
+- `shared_data`：宿主机中存放数据集的文件夹路径。
- `output`：将导出目录设置为该路径后，即可在宿主机中访问导出后的模型。