refine README.md

This commit is contained in:
geekan 2023-07-01 07:30:47 +08:00
parent f438631609
commit 6b068f38da
2 changed files with 20 additions and 100 deletions

View file

@ -4,21 +4,9 @@ # MetaGPT多角色元编程框架
## 目标
1. 我们的最终目标是让 GPT 能够训练、微调,并最终利用自身,以实现**自我进化**
1. 一旦 GPT 能够优化自身,它将有能力持续改进自己的性能,而无需经常手动调整。这种自我进化使得 AI 能够识别自身改进的领域,进行必要的调整,并实施那些改变以更好地达到其目标。**这可能导致系统能力的指数级增长**
2. 目前,我们已经使 GPT 能够以团队的形式工作,协作处理更复杂的任务
1. 例如,`startup.py` 包括**产品经理 / 架构师 / 项目经理 / 工程师**,它提供了一个**软件公司**的全过程
2. 该团队可以合作并生成**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等**
### 哲学
软件公司核心资产有三可运行的代码SOP团队。有公式
```
可运行的代码 = SOP(团队)
```
我们践行了这个过程并且将SOP以代码形式表达了出来而团队本身仅使用了大模型
1. 目前,我们已经使 GPT 能够以团队的形式工作,协作处理更复杂的任务
1. 该团队可以消化**一句话的老板需求**合作并生成**用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等**
2. 该团队包括**产品经理 / 架构师 / 项目经理 / 工程师**,它提供了一个**软件公司**的全过程
## 示例(均由 GPT-4 生成)
@ -27,11 +15,11 @@ ## 示例(均由 GPT-4 生成)
1. 生成一个带有分析和设计的示例大约需要**$0.2** (GPT-4 api 的费用)
2. 生成一个完整项目的示例大约需要**$2.0** (GPT-4 api 的费用)
| | 设计一个支持 GPT-4 和其他 LLMs 的 MLOps/LLMOps 框架 | 设计一个像 Candy Crush Saga 的游戏 | 设计一个像今日头条的 RecSys | 设计一个像 NetHack 的 roguelike 游戏 | 设计一个搜索算法框架 | 设计一个简约的番茄钟计时器 |
|-------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| 竞品分析 | ![LLMOps 竞品分析](resources/workspace/llmops_framework/resources/competitive_analysis.png) | ![Candy Crush 竞品分析](resources/workspace/match3_puzzle_game/resources/competitive_analysis.png) | ![今日头条 Recsys 竞品分析](resources/workspace/content_rec_sys/resources/competitive_analysis.png) | ![NetHack 游戏竞品分析](resources/workspace/pyrogue/resources/competitive_analysis.png) | ![搜索算法框架竞品分析](resources/workspace/search_algorithm_framework/resources/competitive_analysis.png) | ![简约番茄钟计时器竞品分析](resources/workspace/minimalist_pomodoro_timer/resources/competitive_analysis.png) |
| 数据 & API 设计 | ![LLMOps 数据 & API 设计](resources/workspace/llmops_framework/resources/data_api_design.png) | ![Candy Crush 数据 & API 设计](resources/workspace/match3_puzzle_game/resources/data_api_design.png) | ![今日头条 Recsys 数据 & API 设计](resources/workspace/content_rec_sys/resources/data_api_design.png) | ![NetHack 游戏数据 & API 设计](resources/workspace/pyrogue/resources/data_api_design.png) | ![搜索算法框架数据 & API 设计](resources/workspace/search_algorithm_framework/resources/data_api_design.png) | ![简约番茄钟计时器数据 & API 设计](resources/workspace/minimalist_pomodoro_timer/resources/data_api_design.png) |
| 序列流程图 | ![LLMOps 序列流程图](resources/workspace/llmops_framework/resources/seq_flow.png) | ![Candy Crush 序列流程图](resources/workspace/match3_puzzle_game/resources/seq_flow.png) | ![今日头条 Recsys 序列流程图](resources/workspace/content_rec_sys/resources/seq_flow.png) | ![NetHack 游戏序列流程图](resources/workspace/pyrogue/resources/seq_flow.png) | ![搜索算法框架序列流程图](resources/workspace/search_algorithm_framework/resources/seq_flow.png) | ![简约番茄钟计时器序列流程图](resources/workspace/minimalist_pomodoro_timer/resources/seq_flow.png) |
| | 设计一个支持 GPT-4 和其他 LLMs 的 MLOps/LLMOps 框架 | 设计一个像今日头条的 RecSys | 设计一个搜索算法框架 |
|-------------|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| 竞品分析 | ![LLMOps 竞品分析](resources/workspace/llmops_framework/resources/competitive_analysis.png) | ![今日头条 Recsys 竞品分析](resources/workspace/content_rec_sys/resources/competitive_analysis.png) | ![搜索算法框架竞品分析](resources/workspace/search_algorithm_framework/resources/competitive_analysis.png) |
| 数据 & API 设计 | ![LLMOps 数据 & API 设计](resources/workspace/llmops_framework/resources/data_api_design.png) | ![今日头条 Recsys 数据 & API 设计](resources/workspace/content_rec_sys/resources/data_api_design.png) | ![搜索算法框架数据 & API 设计](resources/workspace/search_algorithm_framework/resources/data_api_design.png) |
| 序列流程图 | ![LLMOps 序列流程图](resources/workspace/llmops_framework/resources/seq_flow.png) | ![今日头条 Recsys 序列流程图](resources/workspace/content_rec_sys/resources/seq_flow.png) | ![搜索算法框架序列流程图](resources/workspace/search_algorithm_framework/resources/seq_flow.png) |
## 安装
@ -50,7 +38,7 @@ # 第 3 步:克隆仓库到您的本地机器,并进行安装。
## 配置
- 您可以`config/key.yaml / config/config.yaml / env` 中配置您的 `OPENAI_API_KEY`
- 在 `config/key.yaml / config/config.yaml / env` 中配置您的 `OPENAI_API_KEY`
- 优先级顺序:`config/key.yaml > config/config.yaml > env`
```bash
@ -93,31 +81,7 @@ ### 代码实现
await company.run(n_round=n_round)
```
## 示例单角色能力与底层LLM调用
### 框架同样支持单角色能力以下是一个销售角色完整示例见examples
```python
from metagpt.const import DATA_PATH
from metagpt.document_store import FaissStore
from metagpt.roles import Sales
store = FaissStore(DATA_PATH / 'example.pdf')
role = Sales(profile='Sales', store=store)
result = await role.run('Which facial cleanser is good for oily skin?')
```
### 框架也支持LLM的直接接口
```python
from metagpt.llm import LLM
llm = LLM()
await llm.aask('hello world')
hello_msg = [{'role': 'user', 'content': 'hello'}]
await llm.acompletion(hello_msg)
```
你可以查看`examples`其中有单角色带知识库的使用例子与仅LLM的使用例子。
## 联系信息