Skip to content

Commit f1ba6f5

Browse files
committed
doc(): Added a configuration guide for Config.py
1 parent 54e4bf8 commit f1ba6f5

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ pip install -r requirements.txt
7070
```bash
7171
vim config/config.py
7272
```
73+
参数配置方式与多模型支持参见[config.md](doc/config.md)
74+
7375
4.**运行**
7476
```bash
7577
python3 app.py
@@ -94,6 +96,7 @@ todo dockerfile
9496
# 待办清单 📌
9597

9698
- ✅ 使用 GPT 进行Code Review
99+
- ✅ 实现多模型支持
97100
- [ ] 尝试接入私有化大模型解决代码安全问题
98101
- [ ] 可以配置更多的触发方式
99102
- ✅ Merge Request

doc/config.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Config.py 配置指南
2+
## 大模型配置
3+
- `llm_api_impl`:大模型API接口实现
4+
- 默认`llm_api_default`使用`UnionLLM`进行多模型支持,`UnionLLM`兼容`LiteLLM`
5+
支持模型和参数配置方式参见:[UnionLLM仓库](https://github.com/EvalsOne/UnionLLM/)[LiteLLM文档](https://docs.litellm.ai/docs)
6+
- 主流模型只需要修改`api_config`即可接入,无需修改该参数
7+
- 实现默认不支持的大模型接入,可实现`llm_api_interface`接口,并将类名传入该参数。
8+
- `api_config`: 大模型API配置
9+
- 具体配置参见[UnionLLM仓库](https://github.com/EvalsOne/UnionLLM/)[LiteLLM文档](https://docs.litellm.ai/docs)
10+
- `MODEL_NAME` 传入模型名称
11+
- `PROVIDER` 传入模型提供商
12+
- 该配置会自动传给`llm_api_impl``set_config`方法,用于初始化大模型API。
13+
14+
15+
## Gitlab配置
16+
- `gitlab_server_url`: Gitlab服务器地址
17+
- `gitlab_private_token`: Gitlab私有令牌
18+
- `maximum_files`: Gitlab Merge Request最大文件数
19+
20+
## 消息通知配置
21+
- `dingtalk_webhook`: 钉钉机器人Webhook
22+
- `dingtalk_secret`: 钉钉机器人密钥

0 commit comments

Comments
 (0)