Merge branch 'main' into release/2.4

Author: Jintao-Huang

README.md

@@ -0,0 +1,36 @@
+
+# 推送模型
+
+使用SWIFT时，用户可以选择将训练好的模型推送到魔搭社区上。
+
+要使用推送模型能力，首先要确认你已经注册了魔搭官方账号，并且在[页面](https://www.modelscope.cn/my/myaccesstoken)上取得了对应的sdk token。
+
+## 训练时推送模型
+
+在训练时推送模型，需要在命令行上添加以下参数：
+```shell
+--push_to_hub true \
+--hub_model_id my-group/my-model \
+--hub_token <token-from-modelscope-page>
+```
+
+上述参数添加好后，训练后的checkpoint和训练参数就会被推送到魔搭社区上，方便以后使用。值得注意的是，魔搭社区允许您上传私有模型，需要模型是私有时，添加以下参数:
+
+```shell
+--hub_private_repo true
+```
+
+这样该模型就只有有该组织权限的人才能看到。
+
+## 导出时推送模型
+
+导出时推送模型的参数和训练时的参数是相同的：
+```shell
+CUDA_VISIBLE_DEVICES=0 swift export \
+    --ckpt_dir output/qwen1half-4b-chat/vx-xxx/checkpoint-xxx \
+    --push_to_hub true \
+    --hub_model_id qwen1half-4b-chat-lora \
+    --hub_token '<your-sdk-token>'
+```
+
+这样可以将LoRA合并或量化后的模型直接推送到魔搭上。

README_CN.md

@@ -20,4 +20,4 @@ web-ui可以通过环境变量或者参数控制UI行为。环境变量如下：
 >
 > USE_INFERENCE=1/0 默认0. 控制gradio的推理页面是直接加载模型推理或者部署（USE_INFERENCE=0）
 
-如果使用参数，请参考[命令行参数](../LLM/命令行参数.md#web-ui-参数)。
+如果使用参数，请参考[命令行参数](../Instruction/命令行参数.md#web-ui-参数)。

asset/wechat.png

@@ -24,7 +24,7 @@ pip install -e '.[llm]'
 pip install deepspeed -U
 
 # 如果你想要使用基于auto_gptq的qlora训练. (推荐, 效果优于bnb)
-# 支持auto_gptq的模型: `https://github.com/modelscope/swift/blob/main/docs/source/LLM/支持的模型和数据集.md#模型`
+# 支持auto_gptq的模型: `https://github.com/modelscope/swift/blob/main/docs/source/Instruction/支持的模型和数据集.md#模型`
 # auto_gptq和cuda版本有对应关系，请按照`https://github.com/PanQiWei/AutoGPTQ#quick-installation`选择版本
 pip install auto_gptq -U
 
@@ -37,7 +37,7 @@ pip install -r requirements/llm.txt  -U
 ```
 
 ## 微调
-如果你要使用界面的方式进行微调与推理, 可以查看[界面训练与推理文档](../GetStarted/%E7%95%8C%E9%9D%A2%E8%AE%AD%E7%BB%83%E6%8E%A8%E7%90%86.md).
+如果你要使用界面的方式进行微调与推理, 可以查看[界面训练与推理文档](../GetStarted/界面训练推理.md).
 
 ### 使用python
 ```python
@@ -83,7 +83,7 @@ CUDA_VISIBLE_DEVICES=0 swift sft \
     --output_dir output \
 
 # 使用自己的数据集
-# 自定义数据集格式查看: https://github.com/modelscope/swift/blob/main/docs/source/LLM/%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%8E%E6%8B%93%E5%B1%95.md#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E9%9B%86
+# 自定义数据集格式查看: https://github.com/modelscope/swift/blob/main/docs/source/Instruction/%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%8E%E6%8B%93%E5%B1%95.md#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E9%9B%86
 CUDA_VISIBLE_DEVICES=0 swift sft \
     --model_id_or_path qwen/Qwen-7B-Chat \
     --dataset chatml.jsonl \
@@ -139,7 +139,7 @@ cd examples/pytorch/llm
 - 如果你想要使用基于**auto_gptq**的量化, 你需要先安装对应cuda版本的[auto_gptq](https://github.com/PanQiWei/AutoGPTQ): `pip install auto_gptq -U`.
   > 使用auto_gptq的模型可以查看[LLM支持的模型](支持的模型和数据集.md#模型). 建议使用auto_gptq, 而不是bnb.
 - 如果你想要使用deepspeed, 你需要`pip install deepspeed -U`. 使用deepspeed可以**节约显存**, 但可能会略微降低训练速度.
-- 如果你的训练涉及到**知识编辑**的内容, 例如: [自我认知微调](自我认知微调最佳实践.md), 你需要在MLP上也加上LoRA, 否则可能会效果不佳. 你可以简单传入参数`--lora_target_modules ALL`来对所有的linear(qkvo, mlp)加上lora, **这通常是效果最好的**.
+- 如果你的训练涉及到**知识编辑**的内容, 例如: [自我认知微调](../LLM/自我认知微调最佳实践.md), 你需要在MLP上也加上LoRA, 否则可能会效果不佳. 你可以简单传入参数`--lora_target_modules ALL`来对所有的linear(qkvo, mlp)加上lora, **这通常是效果最好的**.
 - 如果你使用的是**V100**等较老的GPU, 你需要设置`--dtype AUTO`或者`--dtype fp16`, 因为其不支持bf16.
 - 如果你的机器是A100等高性能显卡, 且模型支持flash-attn, 推荐你安装[**flash-attn**](https://github.com/Dao-AILab/flash-attention), 这将会加快训练和推理的速度以及显存占用(A10, 3090, V100等显卡不支持flash-attn进行训练). 支持flash-attn的模型可以查看[LLM支持的模型](支持的模型和数据集.md#模型)
 - 如果你要进行**二次预训练**, **多轮对话**, 你可以参考[自定义与拓展](自定义与拓展.md#注册数据集的方式)
@@ -168,10 +168,10 @@ cd examples/pytorch/llm
 
 
 ## DPO
-如果你要使用DPO进行人类对齐, 你可以查看[DPO训练文档](DPO训练文档.md).
+如果你要使用DPO进行人类对齐, 你可以查看[DPO训练文档](../LLM/DPO训练文档.md).
 
 ## ORPO
-如果你要使用ORPO进行人类对齐, 你可以查看[ORPO最佳实践](ORPO算法最佳实践.md).
+如果你要使用ORPO进行人类对齐, 你可以查看[ORPO最佳实践](../LLM/ORPO算法最佳实践.md).
 
 ## Merge LoRA
 提示: **暂时**不支持bnb和auto_gptq量化模型的merge lora, 这会产生较大的精度损失.
@@ -186,7 +186,7 @@ CUDA_VISIBLE_DEVICES=0 swift export \
 对微调后模型进行量化可以查看[LLM量化与导出文档](LLM量化与导出文档.md#微调后模型)
 
 ## 推理
-如果你要使用VLLM进行推理加速, 可以查看[VLLM推理加速与部署](VLLM推理加速与部署.md#微调后的模型)
+如果你要使用VLLM进行推理加速, 可以查看[VLLM推理加速与部署](../LLM/VLLM推理加速与部署.md#微调后的模型)
 
 ### 原始模型
 **单样本推理**可以查看[LLM推理文档](LLM推理文档.md#推理)
@@ -279,7 +279,7 @@ CUDA_VISIBLE_DEVICES=0 swift infer --ckpt_dir 'xxx/vx-xxx/checkpoint-xxx-merged'
 ```
 
 ## Web-UI
-如果你要使用VLLM进行部署并提供**API**接口, 可以查看[VLLM推理加速与部署](VLLM推理加速与部署.md#部署)
+如果你要使用VLLM进行部署并提供**API**接口, 可以查看[VLLM推理加速与部署](../LLM/VLLM推理加速与部署.md#部署)
 
 ### 原始模型
 使用原始模型的web-ui可以查看[LLM推理文档](LLM推理文档.md#Web-UI)

docs/source/GetStarted/推送模型.md

@@ -1,5 +1,5 @@
 # LLM推理文档
-如果你要使用vllm进行推理加速, 可以查看[VLLM推理加速与部署](VLLM推理加速与部署.md#推理加速)
+如果你要使用vllm进行推理加速, 可以查看[VLLM推理加速与部署](../LLM/VLLM推理加速与部署.md#推理加速)
 
 ## 目录
 - [环境准备](#环境准备)
@@ -15,7 +15,7 @@ pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
 pip install 'ms-swift[llm]' -U
 
 # 如果你想要使用基于auto_gptq的模型进行推理.
-# 使用auto_gptq的模型: `https://github.com/modelscope/swift/blob/main/docs/source/LLM/支持的模型和数据集.md#模型`
+# 使用auto_gptq的模型: `https://github.com/modelscope/swift/blob/main/docs/source/Instruction/支持的模型和数据集.md#模型`
 # auto_gptq和cuda版本有对应关系，请按照`https://github.com/PanQiWei/AutoGPTQ#quick-installation`选择版本
 pip install auto_gptq -U
 

docs/source/GetStarted/界面训练推理.md

@@ -69,15 +69,15 @@ pip install -e '.[eval]'
 ```shell
 # 原始模型 (单卡A100大约需要半小时)
 CUDA_VISIBLE_DEVCIES=0 swift eval --model_type qwen2-7b-instruct \
-    --eval_dataset ARC_e --infer_backend vllm
+    --eval_dataset ARC_c --infer_backend vllm
 
 # LoRA微调后
 CUDA_VISIBLE_DEVICES=0 swift eval --ckpt_dir qwen2-7b-instruct/vx-xxx/checkpoint-xxx \
-    --eval_dataset ARC_e --infer_backend vllm \
+    --eval_dataset ARC_c --infer_backend vllm \
     --merge_lora true \
 ```
 
-评测的参数列表可以参考[这里](./命令行参数.md#eval参数)。
+评测的参数列表可以参考[这里](命令行参数.md#eval参数)。
 
 请注意：评测结果会存储在{--eval_output_dir}/{--name}/{时间戳}下, 如果用户没有改变存储配置，则默认路径在:
 ```text
@@ -93,7 +93,7 @@ CUDA_VISIBLE_DEVICES=0 swift deploy --model_type qwen2-7b-instruct
 
 # 使用API进行评测
 # 如果是非swift部署, 则需要额外传入`--eval_is_chat_model true --model_type qwen2-7b-instruct`
-swift eval --eval_url http://127.0.0.1:8000/v1 --eval_dataset ARC_e
+swift eval --eval_url http://127.0.0.1:8000/v1 --eval_dataset ARC_c
 
 # LoRA微调后的模型同理
 ```