Skip to content

Commit 0d4b16c

Browse files
refactor readme web-ui (#983)
1 parent d1224e0 commit 0d4b16c

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
- [Documentation](#-documentation)
3434
- [License](#-License)
3535
- [Citation](#-citation)
36-
- [Contact Us](#-contact-us)
36+
- [WeChat Group](#-Wechat-Group)
3737

3838
## 📝 Introduction
3939
SWIFT supports training, inference, evaluation and deployment of nearly **200 LLMs and MLLMs** (multimodal large models). Developers can directly apply our framework to their own research and production environments to realize the complete workflow from model training and evaluation to application. In addition to supporting the lightweight training solutions provided by [PEFT](https://github.com/huggingface/peft), we also provide a complete **Adapters library** to support the latest training techniques such as NEFTune, LoRA+, LLaMA-PRO, etc. This adapter library can be used directly in your own custom workflow without our training scripts.
@@ -44,6 +44,8 @@ Additionally, we are expanding capabilities for other modalities. Currently, we
4444

4545
SWIFT has rich documentations for users, please check [here](https://github.com/modelscope/swift/tree/main/docs/source_en/LLM).
4646

47+
SWIFT web-ui is available both on [Huggingface space](https://huggingface.co/spaces/tastelikefeet/swift) and [ModelScope studio](https://www.modelscope.cn/studios/iic/Scalable-lightWeight-Infrastructure-for-Fine-Tuning/summary), please feel free to try!
48+
4749
## 🎉 News
4850
- 2024.05.22: Supports DeepSeek-V2-Lite series models, model_type are `deepseek-v2-lite` and `deepseek-v2-lite-chat`
4951
- 2024.05.22: Supports TeleChat-12B-v2 model with quantized version, model_type are `telechat-12b-v2` and `telechat-12b-v2-gptq-int4`
@@ -200,10 +202,14 @@ This section introduces basic usage, see the [Documentation](#-documentation) se
200202

201203
### Web-UI
202204

205+
Web-UI is a gradio-based interface for **zero-threshold** training and deployment. It is easy to use and perfectly supports multi-GPU training and deployment:
206+
203207
```shell
204-
swift web-ui
208+
SWIFT_UI_LANG=en swift web-ui
205209
```
206210

211+
![image.png](./docs/resources/web-ui-en.jpg)
212+
207213
### Training
208214

209215
#### Training Scripts
@@ -658,7 +664,7 @@ This framework is licensed under the [Apache License (Version 2.0)](https://gith
658664
}
659665
```
660666

661-
## Contact Us
667+
## Wechat Group
662668

663669
You can contact us and communicate with us by adding our WeChat group:
664670

README_CN.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
- [文档](#-文档)
3535
- [License](#-license)
3636
- [引用](#-引用)
37-
- [联系我们](#-联系我们)
37+
- [微信用户群](#-微信用户群)
3838

3939
## 📝 简介
4040
SWIFT支持近**200种LLM和MLLM**(多模态大模型)的训练、推理、评测和部署。开发者可以直接将我们的框架应用到自己的Research和生产环境中,实现模型训练评测到应用的完整链路。我们除支持了[PEFT](https://github.com/huggingface/peft)提供的轻量训练方案外,也提供了一个完整的**Adapters库**以支持最新的训练技术,如NEFTune、LoRA+、LLaMA-PRO等,这个适配器库可以脱离训练脚本直接使用在自己的自定流程中。
@@ -45,6 +45,8 @@ SWIFT支持近**200种LLM和MLLM**(多模态大模型)的训练、推理、
4545

4646
SWIFT具有丰富的文档体系,如有使用问题请请查看[这里](https://github.com/modelscope/swift/tree/main/docs/source/LLM).
4747

48+
可以在[Huggingface space](https://huggingface.co/spaces/tastelikefeet/swift)[ModelScope创空间](https://www.modelscope.cn/studios/iic/Scalable-lightWeight-Infrastructure-for-Fine-Tuning/summary) 中体验SWIFT web-ui功能了。
49+
4850
## 🎉 新闻
4951
- 2024.05.22: 支持DeepSeek-V2-lite系列模型, model_type为 `deepseek-v2-lite``deekseek-v2-lite-chat`
5052
- 2024.05.22: 支持TeleChat-12b-v2模型和量化版本, model_type为 `telechat-12b-v2``telechat-12b-v2-gptq-int4`
@@ -202,9 +204,12 @@ docker pull registry.us-west-1.aliyuncs.com/modelscope-repo/modelscope:ubuntu22.
202204

203205
### Web-UI
204206

207+
Web-UI是基于gradio界面技术的**零门槛**训练部署界面方案。Web-UI配置简单,且完美支持多卡训练和部署:
208+
205209
```shell
206210
swift web-ui
207211
```
212+
![image.png](./docs/resources/web-ui.png)
208213

209214
### 训练
210215

@@ -659,7 +664,7 @@ make docs
659664
}
660665
```
661666

662-
## 联系我们
667+
## 微信用户群
663668

664669
您可以通过加我们的微信群, 来和我们联系和交流:
665670

docs/resources/web-ui-en.jpg

208 KB
Loading

0 commit comments

Comments
 (0)