| # SWIFT安装 |
|
|
| ## Wheel包安装 |
|
|
| 可以使用pip进行安装： |
|
|
| ```shell |
| # 推荐 |
| pip install 'ms-swift' -U |
| # 额外安装megatron依赖 |
| pip install 'ms-swift[megatron]' -U |
| # 额外安装评测依赖 |
| pip install 'ms-swift[eval]' -U |
| # 全能力 |
| pip install 'ms-swift[all]' -U |
| |
| # 使用uv |
| pip install uv |
| uv pip install 'ms-swift' --torch-backend=auto |
| ``` |
|
|
| ## 源代码安装 |
|
|
| 当前main分支为 swift4.x 版本。 |
| ```shell |
| # pip install git+https://github.com/modelscope/ms-swift.git |
| |
| # 全能力 |
| # pip install "git+https://github.com/modelscope/ms-swift.git#egg=ms-swift[all]" |
| |
| git clone https://github.com/modelscope/ms-swift.git |
| cd ms-swift |
| pip install -e . |
| |
| # 使用 uv |
| uv pip install -e . --torch-backend=auto |
| |
| # 全能力 |
| # pip install -e '.[all]' |
| ``` |
|
|
| 安装swift3.x： |
| ```shell |
| # pip install "git+https://github.com/modelscope/ms-swift.git@release/3.12" |
| |
| # 全能力 |
| # pip install "git+https://github.com/modelscope/ms-swift.git@release/3.12#egg=ms-swift[all]" |
| |
| git clone -b release/3.12 https://github.com/modelscope/ms-swift.git |
| cd ms-swift |
| pip install -e . |
| |
| # 全能力 |
| # pip install -e '.[all]' |
| ``` |
|
|
| ## 镜像 |
|
|
| docker可以查看[这里](https://github.com/modelscope/modelscope/blob/build_swift_image/docker/build_image.py#L392)。 |
| ``` |
| # swift4.1.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py312-torch2.10.0-vllm0.19.1-modelscope1.35.4-swift4.1.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py312-torch2.10.0-vllm0.19.1-modelscope1.35.4-swift4.1.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py312-torch2.10.0-vllm0.19.1-modelscope1.35.4-swift4.1.3 |
| |
| # swift4.0.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.10.0-vllm0.17.1-modelscope1.34.0-swift4.0.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.10.0-vllm0.17.1-modelscope1.34.0-swift4.0.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.10.0-vllm0.17.1-modelscope1.34.0-swift4.0.3 |
| |
| # swift3.12.5 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.9.0-vllm0.13.0-modelscope1.33.0-swift3.12.5 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.9.0-vllm0.13.0-modelscope1.33.0-swift3.12.5 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.9.0-vllm0.13.0-modelscope1.33.0-swift3.12.5 |
| |
| # swift3.11.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py311-torch2.8.0-vllm0.11.0-modelscope1.32.0-swift3.11.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py311-torch2.8.0-vllm0.11.0-modelscope1.32.0-swift3.11.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.9.1-py311-torch2.8.0-vllm0.11.0-modelscope1.32.0-swift3.11.3 |
| ``` |
|
|
| <details><summary>历史镜像</summary> |
|
|
| ``` |
| # swift3.10.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.10.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.10.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.10.3 |
| |
| # swift3.9.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.9.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.9.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.8.1-py311-torch2.8.0-vllm0.11.0-modelscope1.31.0-swift3.9.3 |
| |
| # swift3.8.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.1.1-modelscope1.29.2-swift3.8.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.1.1-modelscope1.29.2-swift3.8.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.1.1-modelscope1.29.2-swift3.8.3 |
| |
| # swift3.7.2 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.0-modelscope1.28.2-swift3.7.2 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.0-modelscope1.28.2-swift3.7.2 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.6.3-py311-torch2.7.1-vllm0.10.0-modelscope1.28.2-swift3.7.2 |
| |
| # swift3.6.4 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.28.1-swift3.6.4 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.28.1-swift3.6.4 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.28.1-swift3.6.4 |
| |
| # swift3.5.3 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.27.1-swift3.5.3 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.27.1-swift3.5.3 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py310-torch2.6.0-vllm0.8.5.post1-modelscope1.27.1-swift3.5.3 |
| |
| # swift3.4.1.post1 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.6.0-vllm0.8.5.post1-modelscope1.26.0-swift3.4.1.post1 |
| modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.6.0-vllm0.8.5.post1-modelscope1.26.0-swift3.4.1.post1 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.6.0-vllm0.8.5.post1-modelscope1.26.0-swift3.4.1.post1 |
| |
| # swift3.3.0.post1 |
| modelscope-registry.cn-hangzhou.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.6.0-vllm0.8.3-modelscope1.25.0-swift3.3.0.post1 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.6.0-vllm0.8.3-modelscope1.25.0-swift3.3.0.post1 |
| |
| # swift3.2.2 |
| modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.04-cuda12.4.0-py311-torch2.5.1-modelscope1.25.0-swift3.2.2 |
| ``` |
| </details> |
|
|
| 更多镜像可以查看[这里](https://modelscope.cn/docs/intro/environment-setup#%E6%9C%80%E6%96%B0%E9%95%9C%E5%83%8F)。 |
|
|
| ## 支持的硬件 |
|
|
| | 硬件环境 | 备注 | |
| | --------------- | --------------------------- | |
| | A10/A100/H100 | | |
| | RTX20/30/40系列 | | |
| | T4/V100 | 部分模型出现NAN | |
| | Ascend NPU | 部分模型出现NAN或算子不支持 | |
| | MPS | 参考[issue 4572](https://github.com/modelscope/ms-swift/issues/4572) | |
| | CPU | | |
|
|
|
|
| ## 运行环境 |
|
|
| | | 范围 | 推荐 | 备注 | |
| |--------------|--------------|---------------------|--------------------| |
| | python | >=3.10 | 3.12 | | |
| | cuda | | cuda12.8/12.9 | 使用cpu、npu、mps则无需安装 | |
| | torch | >=2.0 | 2.8.0/2.10.0 | | |
| | transformers | >=4.33 | 4.57.6/5.6.2 | | |
| | modelscope | >=1.23 | | | |
| | peft | >=0.11,<0.20 | | | |
| | flash_attn | | 2.8.3/3.0.0b1 | | |
| | trl | >=0.15,<1.0 | 0.29.1 | RLHF | |
| | deepspeed | >=0.14 | 0.18.9 | 训练 | |
| | vllm | >=0.5.1 | 0.11.0/0.19.1 | 推理/部署 | |
| | sglang | >=0.4.6 | | 推理/部署 | |
| | lmdeploy | >=0.5 | 0.10.1 | 推理/部署 | |
| | evalscope | >=1.0 | | 评测 | |
| | gradio | | 5.32.1 | Web-UI/App | |
| |
| 更多可选依赖可以参考[这里](https://github.com/modelscope/ms-swift/blob/main/requirements/install_all.sh)。 |
| |
| ## Notebook环境 |
| |
| Swift支持训练的绝大多数模型都可以在`A10`显卡上使用，用户可以使用ModelScope官方提供的免费显卡资源： |
| |
| 1. 进入[ModelScope](https://www.modelscope.cn)官方网站并登录。 |
| 2. 点击左侧的`我的Notebook`并开启一个免费GPU实例。 |
| 3. 愉快地薅A10显卡羊毛。 |
| |
