yuccaaa commited on
Commit
012e620
·
verified ·
1 Parent(s): 129b047

Upload ms-swift/docs/source_en/GetStarted/SWIFT-installation.md with huggingface_hub

Browse files
ms-swift/docs/source_en/GetStarted/SWIFT-installation.md ADDED
@@ -0,0 +1,88 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # SWIFT Installation
2
+
3
+ ## Wheel Packages Installation
4
+
5
+ You can install it using pip:
6
+
7
+ ```shell
8
+ pip install 'ms-swift'
9
+ # For evaluation usage
10
+ pip install 'ms-swift[eval]' -U
11
+ # Full capabilities
12
+ pip install 'ms-swift[all]' -U
13
+ ```
14
+
15
+ ## Source Code Installation
16
+
17
+ ```shell
18
+ # pip install git+https://github.com/modelscope/ms-swift.git
19
+
20
+ # Full capabilities
21
+ # pip install "git+https://github.com/modelscope/ms-swift.git#egg=ms-swift[all]"
22
+
23
+ git clone https://github.com/modelscope/ms-swift.git
24
+ cd ms-swift
25
+ pip install -e .
26
+
27
+ # Full capabilities
28
+ # pip install -e '.[all]'
29
+ ```
30
+
31
+ ## Older Versions
32
+
33
+ SWIFT underwent an incompatible restructuring starting from version 3.0. If you need to use the old version 2.x, please execute the following command to install:
34
+
35
+ ```shell
36
+ pip install ms-swift==2.*
37
+ ```
38
+
39
+ ## Mirror
40
+
41
+ ```
42
+ # vllm0.8.3 (This version of vllm may cause some GRPO training to get stuck; it is recommended to use vllm0.7.3 for GRPO training as a priority).
43
+ 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
44
+ 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
45
+
46
+ # vllm0.7.3
47
+ 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
48
+ ```
49
+
50
+ More images can be found [here](https://modelscope.cn/docs/intro/environment-setup#%E6%9C%80%E6%96%B0%E9%95%9C%E5%83%8F).
51
+
52
+ ## Supported Hardware
53
+
54
+ | Hardware Environment | Remarks |
55
+ | -------------------- | ------------------------------------------------------ |
56
+ | A10/A100/H100 | |
57
+ | RTX 20/30/40 Series | |
58
+ | T4/V100 | Some models may encounter NAN |
59
+ | Ascend NPU | Some models may encounter NAN or unsupported operators |
60
+ | MPS | |
61
+ | CPU | |
62
+
63
+
64
+ ## Running Environment
65
+
66
+ | | Range | Recommended | Notes |
67
+ | ------------ |--------------| ----------- | ----------------------------------------- |
68
+ | python | >=3.9 | 3.10 | |
69
+ | cuda | | cuda12 | No need to install if using CPU, NPU, MPS |
70
+ | torch | >=2.0 | | |
71
+ | transformers | >=4.33 | 4.51 | |
72
+ | modelscope | >=1.19 | | |
73
+ | peft | >=0.11,<0.16 | | |
74
+ | trl | >=0.13,<0.17 | 0.16 | RLHF |
75
+ | deepspeed | >=0.14 | 0.14.5 | Training |
76
+ | vllm | >=0.5.1 | 0.7.3/0.8.3 | Inference/Deployment/Evaluation |
77
+ | lmdeploy | >=0.5 | 0.7.2.post1 | Inference/Deployment/Evaluation |
78
+ | evalscope | >=0.11 | | Evaluation |
79
+
80
+ For more optional dependencies, you can refer to [here](https://github.com/modelscope/ms-swift/blob/main/requirements/install_all.sh).
81
+
82
+ ## Notebook Environment
83
+
84
+ Most models that Swift supports for training can be used on A10 GPUs. Users can take advantage of the free GPU resources offered by ModelScope:
85
+
86
+ 1. Visit the [ModelScope](https://www.modelscope.cn) official website and log in.
87
+ 2. Click on `My Notebook` on the left and start a free GPU instance.
88
+ 3. Enjoy utilizing the A10 GPU resources.