Skip to content

Commit 09ea1bb

Browse files
committed
doc(README README_EN): Enhance the README.md, sync the README_EN.md ,fix a bug in args_check.py
1 parent 0835f4e commit 09ea1bb

File tree

3 files changed

+90
-7
lines changed

3 files changed

+90
-7
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
<a href="https://tqz0rsrhsvf.feishu.cn/docx/FlgzdMrj0oYOg2xXY7EcrsZZnjb?from=from_copylink">📚 官方文档</a>
1313
</p>
1414
<p align="center">
15-
<a href="#项目描述">🔍 项目描述</a> •
16-
<a href="#功能预览">🍭 功能预览</a> •
17-
<a href="#部署">🔧 部署安装</a> •
18-
<a href="#待办清单">📌 待办清单</a>
19-
<a href="#联系我们">🚗 联系我们 </a>
15+
<a href="#项目描述-">🔍 项目描述</a> •
16+
<a href="#功能预览-">🍭 功能预览</a> •
17+
<a href="#部署-">🔧 部署安装</a> •
18+
<a href="#待办清单-">📌 待办清单</a>
19+
<a href="#交流-">🚗 联系我们 </a>
2020
</p>
2121

2222
# 项目描述 📚
@@ -159,6 +159,7 @@ vim config/config.py
159159
python3 app.py
160160
```
161161
5.**配置Gitlab webhook**
162+
> 填写```Webhook URL```时,请在域名后添加路径```/git/webhook```,例如:```http://example.com/git/webhook```
162163
<p align="center">
163164
<img src="doc/img/webhookconfig.png" style="width:300px;"/>
164165
</p>

README_EN.md

Lines changed: 83 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,88 @@
4444
<img src="doc/img/img.png" style="width:500px;"/>
4545
</p>
4646

47-
47+
### 3. Integration of More Large Models
48+
49+
1. Custom models can be quickly integrated by implementing the project interface.
50+
For specific configuration methods, refer to [config.md](doc/config.md).
51+
2. The project supports multiple models through [UnionLLM](https://github.com/EvalsOne/UnionLLM/),
52+
which is compatible with [LiteLLM](https://docs.litellm.ai/docs).
53+
The default supported models are listed in the table below.
54+
55+
<table style="width:100%; text-align:center; border-collapse:collapse;">
56+
<tr>
57+
<td>OpenAI</td>
58+
<td>Azure</td>
59+
<td>AWS - SageMaker</td>
60+
<td>AWS - Bedrock</td>
61+
</tr>
62+
<tr>
63+
<td>Google - Vertex_AI</td>
64+
<td>Google - Palm</td>
65+
<td>Google AI Studio - Gemini</td>
66+
<td>Mistral AI API</td>
67+
</tr>
68+
<tr>
69+
<td>Cloudflare AI Workers</td>
70+
<td>Cohere</td>
71+
<td>Anthropic</td>
72+
<td>Empower</td>
73+
</tr>
74+
<tr>
75+
<td>Huggingface</td>
76+
<td>Replicate</td>
77+
<td>Together_AI</td>
78+
<td>OpenRouter</td>
79+
</tr>
80+
<tr>
81+
<td>AI21</td>
82+
<td>Baseten</td>
83+
<td>Vllm</td>
84+
<td>NLP_Cloud</td>
85+
</tr>
86+
<tr>
87+
<td>Aleph Alpha</td>
88+
<td>Petals</td>
89+
<td>Ollama</td>
90+
<td>Deepinfra</td>
91+
</tr>
92+
<tr>
93+
<td>Perplexity-AI</td>
94+
<td>Groq AI</td>
95+
<td>DeepSeek</td>
96+
<td>Anyscale</td>
97+
</tr>
98+
<tr>
99+
<td>IBM - Watsonx.ai</td>
100+
<td>Voyage AI</td>
101+
<td>Xinference [Xorbits Inference]</td>
102+
<td>FriendliAI</td>
103+
</tr>
104+
<tr>
105+
<td>Galadriel</td>
106+
<td>智谱AI</td>
107+
<td>月之暗面 Moonshot</td>
108+
<td>百度文心一言</td>
109+
</tr>
110+
<tr>
111+
<td>阿里巴巴通义千问</td>
112+
<td>MiniMax</td>
113+
<td>讯飞星火</td>
114+
<td>百川智能</td>
115+
</tr>
116+
<tr>
117+
<td>昆仑天工</td>
118+
<td>零一万物</td>
119+
<td>阶跃星辰</td>
120+
<td>字节豆包</td>
121+
</tr>
122+
<tr>
123+
<td>DeepSeek</td>
124+
<td>More</td>
125+
<td></td>
126+
<td></td>
127+
</tr>
128+
</table>
48129
# Usage 📖
49130

50131
### install
@@ -66,6 +147,7 @@ vim config/config.py
66147
python3 app.py
67148
```
68149
5.**config gitlab webhook**
150+
> When filling in the ```Webhook URL```, please add ```/git/webhook``` after the domain name. For example: ```http://example.com/git/webhook```
69151
<p align="center">
70152
<img src="doc/img/webhookconfig.png" style="width:300px;"/>
71153
</p>

utils/args_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ def check_config():
1010
try:
1111
import config.config as config
1212
if check_exist(config, ["llm_api_impl", "api_config", "gpt_message",
13-
"gitlab_server_url", "gitlab_private_token"]):
13+
"gitlab_server_url", "gitlab_private_token", "dingding_bot_webhook", "dingding_secret"]):
1414
results.append(["Configuration parameter existence", "Passed", "", "✅ Required parameters are available."])
1515
else:
1616
results.append(["Configuration parameter existence", "Failed", "Required parameters are missing", "❌ Required parameters are missing"])

0 commit comments

Comments
 (0)