OpenBMB/ChatDev
1
1
Fork 0
mirror of https://github.com/OpenBMB/ChatDev.git synced 2024-10-06 15:48:26 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve software contribution page

Browse Source
This commit is contained in:
thinkwee 2023-09-06 11:06:31 +08:00
parent 0413488a5d
commit 433fa54557
5 changed files with 350 additions and 688 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

218
Contribution.md Normal file
View File

@ -0,0 +1,218 @@
# Community Contribution Software
<table style="width:100%">
<thead>
<tr>
<th>Contributor</th>
<th>Software</th>
<th>ScreenShot</th>
<th>Status</th>
<th>LLM</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4"><a href="https://github.com/qianc62" target="_blank" rel="noopener noreferrer">https://github.com/qianc62</a></td>
<td><a href="WareHouse/Website_THUNLP_20230725154612" target="_blank" rel="noopener noreferrer">A simple website</a></td>
<td><img src="misc/website.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/FlappyBird_THUNLP_20230726121145" target="_blank" rel="noopener noreferrer">FlappyBirds Game</a></td>
<td><img src="misc/flappy_bird.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game</a></td>
<td><img src="misc/gomoku.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Calculator_THUNLP_20230628184918" target="_blank" rel="noopener noreferrer">A calculator with bottom icons generated by Agents</a></td>
<td><img src="misc/calc.jpg" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="17"><a href="https://github.com/thinkwee" target="_blank" rel="noopener noreferrer">https://github.com/thinkwee</a></td>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">Painter</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/pingpong_THUNLP_20230817193956" target="_blank" rel="noopener noreferrer">PingPong Game</a></td>
<td><img src="misc/pingpong.jpg" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelRunner_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">PixelRunner</a></td>
<td><img src="misc/jump_game.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MoneyCtrl_THUNLP_20230825093546" target="_blank" rel="noopener noreferrer">BudgetControl</a></td>
<td><img src="misc/budget.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelCraft_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">PixelCraft</a></td>
<td><img src="misc/pixel_art.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MazeGenerator_THUNLP_20230825093601" target="_blank" rel="noopener noreferrer">MazeGenerator</a></td>
<td><img src="misc/maze_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Matchy_Match_THUNLP_20230825101854" target="_blank" rel="noopener noreferrer">Matchy_Match</a></td>
<td><img src="misc/memory_card_game.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PasswordGenerator_THUNLP_20230825072337" target="_blank" rel="noopener noreferrer">Password Generator</a></td>
<td><img src="misc/password_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ToDo_THUNLP_20230825072331" target="_blank" rel="noopener noreferrer">Todo</a></td>
<td><img src="misc/todo.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ExpenseEase_THUNLP_20230825093604" target="_blank" rel="noopener noreferrer">Expensechart</a></td>
<td><img src="misc/expense_visualizer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/2048_THUNLP_20230822144615" target="_blank" rel="noopener noreferrer">2048 Game</a></td>
<td><img src="misc/2048.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/WordExpand_THUNLP_20230825093623" target="_blank" rel="noopener noreferrer">WordExpand</a></td>
<td><img src="misc/vocab.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Fish_Tycoon_THUNLP_20230825093543" target="_blank" rel="noopener noreferrer">Fish Tycoon</a></td>
<td><img src="misc/aquarium.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DigitalClock_THUNLP_20230825093556" target="_blank" rel="noopener noreferrer">Digital Clock</a></td>
<td><img src="misc/clock.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/CurrencyWiz_THUNLP_20230825101851" target="_blank" rel="noopener noreferrer">CurrencyWiz</a></td>
<td><img src="misc/currency_converter.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DesignDream_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">Design Dream</a></td>
<td><img src="misc/home_design.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DiceRollingSimulator_THUNLP_20230825072338" target="_blank" rel="noopener noreferrer">DiceRollingSimulator</a></td>
<td><img src="misc/dice.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="6"><a href="https://github.com/NA-Wen" target="_blank" rel="noopener noreferrer">https://github.com/NA-Wen</a></td>
<td><a href="WareHouse/md2html_THUNLP_md2html" target="_blank" rel="noopener noreferrer">md2html</a></td>
<td><img src="misc/markdown2html.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game with assets generated by Agent</a></td>
<td><img src="misc/gomoku_art.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/mspaint_THUNLP_20230821204606" target="_blank" rel="noopener noreferrer">MsPaint</a></td>
<td><img src="misc/mspaint.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ImgEditor_THUNLP_20230824142740" target="_blank" rel="noopener noreferrer">Image Editor</a></td>
<td><img src="misc/image_editor.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">ArtCanvas</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/TicTacToe_THUNLP_20230825093547" target="_blank" rel="noopener noreferrer">TicTacToe</a></td>
<td><img src="misc/tictactoe.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="5"><a href="https://github.com/lijiahao2022" target="_blank" rel="noopener noreferrer">https://github.com/lijiahao2022</a></td>
<td><a href="WareHouse/musicplayer_THUNLP_20230824113404" target="_blank" rel="noopener noreferrer">Music Player</a></td>
<td><img src="misc/music_player.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/Typing_THUNLP_20230824105537" target="_blank" rel="noopener noreferrer">Typing Test</a></td>
<td><img src="misc/typing_test.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/videoplayer_THUNLP_20230824233151" target="_blank" rel="noopener noreferrer">Video Player</a></td>
<td><img src="misc/video_player.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/timer_THUNLP_20230823091709" target="_blank" rel="noopener noreferrer">Timer</a></td>
<td><img src="misc/timer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/BookBreeze_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">BookBreeze</a></td>
<td><img src="misc/ebook_reader.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="1"><a href="https://github.com/GeekyWizKid" target="_blank" rel="noopener noreferrer">https://github.com/GeekyWizKid</a></td>
<td><a href="WareHouse/tiny_rogue_like_DefaultOrganization_20230905232453" target="_blank" rel="noopener noreferrer">Tiny Rogue-like Game</a></td>
<td><img src="misc/tiny_rogue.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
</tbody>
</table>

258
README-Chinese.md
View File

@ -8,12 +8,15 @@
## 📖 概述
- **ChatDev** 是一家**虚拟软件公司**，通过各种不同角色的**智能体**运营，包括执行官、技术官、程序员、测试员等。这些智能体形成了一个多智能体组织结构，其使命是“通过编程改变数字世界”。ChatDev内的智能体通过参加专业的功能研讨会来**协作**，包括设计、编码、测试和文档编写等任务。
- **ChatDev** 是一家**虚拟软件公司**，通过各种不同角色的**智能体**
运营，包括执行官、技术官、程序员、测试员等。这些智能体形成了一个多智能体组织结构，其使命是“通过编程改变数字世界”。ChatDev内的智能体通过参加专业的功能研讨会来
**协作**，包括设计、编码、测试和文档编写等任务。
- ChatDev的主要目标是提供一个基于大型语言模型（LLM）的**易于使用**、**高度可定制**并且**可扩展**的框架，它是研究群体智能的理想场景。
## 📰 新闻
- **2023年9月1日：Art模式现已可用！您可以使用智能体生成软件中使用的图像，尝试 `python3 run.py --config "Art"`。** 请参见此处的[示例](/WareHouse/gomokugameArtExample_THUNLP_20230831122822)。
- **2023年9月1日：Art模式现已可用！您可以使用智能体生成软件中使用的图像，尝试 `python3 run.py --config "Art"`。**
请参见此处的[示例](/WareHouse/gomokugameArtExample_THUNLP_20230831122822)。
- 2023年8月28日：系统已公开提供使用。
- 2023年8月17日：V1.0.0版本已准备好发布。
- 2023年7月30日：用户可以自定义ChatChain、Phase和Role设置。此外，现在支持在线Log模式和重放模式。
@ -24,8 +27,6 @@
![intro](misc/intro.png)
https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9bb62b72
## ⚡️ 快速开始
@ -38,7 +39,8 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
git clone https://github.com/OpenBMB/ChatDev.git
```
2. **设置Python环境：** 确保您具有3.9或更高版本的Python环境。您可以使用以下命令创建并激活环境，可以将`ChatDev_conda_env`替换为您喜欢的环境名称：
2. **设置Python环境：** 确保您具有3.9或更高版本的Python环境。您可以使用以下命令创建并激活环境，可以将`ChatDev_conda_env`
替换为您喜欢的环境名称：
```
conda create -n ChatDev_conda_env python=3.9 -y
@ -52,7 +54,8 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
pip3 install -r requirements.txt
```
4. **设置OpenAI API密钥：** 将您的OpenAI API密钥导出为环境变量。将`"your_OpenAI_API_key"`替换为您的实际API密钥。请注意，此环境变量是特定于会话的，因此如果打开新的终端会话，您需要重新设置它。 在Unix/Linux系统上：
4. **设置OpenAI API密钥：** 将您的OpenAI API密钥导出为环境变量。将`"your_OpenAI_API_key"`
替换为您的实际API密钥。请注意，此环境变量是特定于会话的，因此如果打开新的终端会话，您需要重新设置它。 在Unix/Linux系统上：
```
export OPENAI_API_KEY="your_OpenAI_API_key"
@ -64,13 +67,15 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
$env:OPENAI_API_KEY="your_OpenAI_API_key"
```
5. **构建您的软件：** 使用以下命令启动生成您的软件，将`[description_of_your_idea]`替换为您的想法描述，将`[project_name]`替换为您想要的项目名称：
5. **构建您的软件：** 使用以下命令启动生成您的软件，将`[description_of_your_idea]`替换为您的想法描述，将`[project_name]`
替换为您想要的项目名称：
```
python3 run.py --task "[description_of_your_idea]" --name "[project_name]"
```
6. **运行您的软件：** 生成后，您可以在`WareHouse`目录下的特定项目文件夹中找到您的软件，例如`project_name_DefaultOrganization_timestamp`。在该目录中运行以下命令来运行您的软件：
6. **运行您的软件：** 生成后，您可以在`WareHouse`
目录下的特定项目文件夹中找到您的软件，例如`project_name_DefaultOrganization_timestamp`。在该目录中运行以下命令来运行您的软件：
```
cd WareHouse/project_name_DefaultOrganization_timestamp
@ -86,235 +91,36 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
- ChatDev框架的概述。
- ChatChain配置中的所有高级参数的全面介绍。
- 自定义ChatDev的指南，包括：
- ChatChain：设计您自己的软件开发流程（或任何其他流程），例如`DemandAnalysis -> Coding -> Testing -> Manual`。
- Phase：在ChatChain内部设计您自己的Phase，比如`DemandAnalysis`。
- Role：定义您公司内的各种智能体，例如“首席执行官”。
- ChatChain：设计您自己的软件开发流程（或任何其他流程），例如`DemandAnalysis -> Coding -> Testing -> Manual`。
- Phase：在ChatChain内部设计您自己的Phase，比如`DemandAnalysis`。
- Role：定义您公司内的各种智能体，例如“首席执行官”。
## 🤗 分享您的软件！
**代码：** 我们对您参与我们的开源项目表示热情欢迎。如果您遇到任何问题，请不要犹豫报告它们。如果您准备与我们分享您的工作，随时创建pull request！您的贡献非常宝贵。如果您需要帮助，请联系我们！
**代码：** 我们对您参与我们的开源项目表示热情欢迎。如果您遇到任何问题，请不要犹豫报告它们。如果您准备与我们分享您的工作，随时创建pull
request！您的贡献非常宝贵。如果您需要帮助，请联系我们！
**公司：** 创建自己定制的“ChatDev公司”非常简单。此个性化设置涉及三个简单的配置JSON文件。请查看`CompanyConfig/Default`目录中提供的示例。有关自定义的详细说明，请参阅我们的[Wiki](wiki.md)。
**公司：** 创建自己定制的“ChatDev公司”非常简单。此个性化设置涉及三个简单的配置JSON文件。请查看`CompanyConfig/Default`
目录中提供的示例。有关自定义的详细说明，请参阅我们的[Wiki](wiki.md)。
**软件：** 每当您使用ChatDev开发软件时，都会生成一个包含所有必要信息的相应文件夹。与我们分享您的工作就像创建一个pull request一样简单。这是一个示例：执行命令`python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"`。这将创建一个软件包并生成一个名为`/WareHouse/2048_THUNLP_timestamp`的文件夹。其中包括：
**软件：** 每当您使用ChatDev开发软件时，都会生成一个包含所有必要信息的相应文件夹。与我们分享您的工作就像创建一个pull
request一样简单。这是一个示例：执行命令`python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"`
。这将创建一个软件包并生成一个名为`/WareHouse/2048_THUNLP_timestamp`的文件夹。其中包括：
- 所有与2048游戏软件相关的文件和文档
- 负责此软件的公司的配置文件，包括`CompanyConfig/Default`中的三个JSON配置文件
- 描述软件构建过程的详细日志，可用于重播（`timestamp.log`）
- 用于创建此软件的初始提示（`2048.prompt`）
以下是由ChatDev创建的一些示例：
**参观社区制造分享的[软件](contribution.md)!**
<table style="width:100%">
<thead>
<tr>
<th>贡献者</th>
<th>软件</th>
<th>截图</th>
<th>状态</th>
<th>基座</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4"><a href="https://github.com/qianc62" target="_blank" rel="noopener noreferrer">https://github.com/qianc62</a></td>
<td><a href="WareHouse/Website_THUNLP_20230725154612" target="_blank" rel="noopener noreferrer">A simple website</a></td>
<td><img src="misc/website.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/FlappyBird_THUNLP_20230726121145" target="_blank" rel="noopener noreferrer">FlappyBirds Game</a></td>
<td><img src="misc/flappy_bird.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game</a></td>
<td><img src="misc/gomoku.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Calculator_THUNLP_20230628184918" target="_blank" rel="noopener noreferrer">A calculator with bottom icons generated by Agents</a></td>
<td><img src="misc/calc.jpg" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="17"><a href="https://github.com/thinkwee" target="_blank" rel="noopener noreferrer">https://github.com/thinkwee</a></td>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">Painter</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/pingpong_THUNLP_20230817193956" target="_blank" rel="noopener noreferrer">PingPong Game</a></td>
<td><img src="misc/pingpong.jpg" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelRunner_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">PixelRunner</a></td>
<td><img src="misc/jump_game.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MoneyCtrl_THUNLP_20230825093546" target="_blank" rel="noopener noreferrer">BudgetControl</a></td>
<td><img src="misc/budget.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelCraft_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">PixelCraft</a></td>
<td><img src="misc/pixel_art.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MazeGenerator_THUNLP_20230825093601" target="_blank" rel="noopener noreferrer">MazeGenerator</a></td>
<td><img src="misc/maze_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Matchy_Match_THUNLP_20230825101854" target="_blank" rel="noopener noreferrer">Matchy_Match</a></td>
<td><img src="misc/memory_card_game.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PasswordGenerator_THUNLP_20230825072337" target="_blank" rel="noopener noreferrer">Password Generator</a></td>
<td><img src="misc/password_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ToDo_THUNLP_20230825072331" target="_blank" rel="noopener noreferrer">Todo</a></td>
<td><img src="misc/todo.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ExpenseEase_THUNLP_20230825093604" target="_blank" rel="noopener noreferrer">Expensechart</a></td>
<td><img src="misc/expense_visualizer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/2048_THUNLP_20230822144615" target="_blank" rel="noopener noreferrer">2048 Game</a></td>
<td><img src="misc/2048.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/WordExpand_THUNLP_20230825093623" target="_blank" rel="noopener noreferrer">WordExpand</a></td>
<td><img src="misc/vocab.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Fish_Tycoon_THUNLP_20230825093543" target="_blank" rel="noopener noreferrer">Fish Tycoon</a></td>
<td><img src="misc/aquarium.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DigitalClock_THUNLP_20230825093556" target="_blank" rel="noopener noreferrer">Digital Clock</a></td>
<td><img src="misc/clock.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/CurrencyWiz_THUNLP_20230825101851" target="_blank" rel="noopener noreferrer">CurrencyWiz</a></td>
<td><img src="misc/currency_converter.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DesignDream_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">Design Dream</a></td>
<td><img src="misc/home_design.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DiceRollingSimulator_THUNLP_20230825072338" target="_blank" rel="noopener noreferrer">DiceRollingSimulator</a></td>
<td><img src="misc/dice.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="6"><a href="https://github.com/NA-Wen" target="_blank" rel="noopener noreferrer">https://github.com/NA-Wen</a></td>
<td><a href="WareHouse/md2html_THUNLP_md2html" target="_blank" rel="noopener noreferrer">md2html</a></td>
<td><img src="misc/markdown2html.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game with assets generated by Agent</a></td>
<td><img src="misc/gomoku_art.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/mspaint_THUNLP_20230821204606" target="_blank" rel="noopener noreferrer">MsPaint</a></td>
<td><img src="misc/mspaint.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ImgEditor_THUNLP_20230824142740" target="_blank" rel="noopener noreferrer">Image Editor</a></td>
<td><img src="misc/image_editor.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">ArtCanvas</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/TicTacToe_THUNLP_20230825093547" target="_blank" rel="noopener noreferrer">TicTacToe</a></td>
<td><img src="misc/tictactoe.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="5"><a href="https://github.com/lijiahao2022" target="_blank" rel="noopener noreferrer">https://github.com/lijiahao2022</a></td>
<td><a href="WareHouse/musicplayer_THUNLP_20230824113404" target="_blank" rel="noopener noreferrer">Music Player</a></td>
<td><img src="misc/music_player.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/Typing_THUNLP_20230824105537" target="_blank" rel="noopener noreferrer">Typing Test</a></td>
<td><img src="misc/typing_test.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/videoplayer_THUNLP_20230824233151" target="_blank" rel="noopener noreferrer">Video Player</a></td>
<td><img src="misc/video_player.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/timer_THUNLP_20230823091709" target="_blank" rel="noopener noreferrer">Timer</a></td>
<td><img src="misc/timer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/BookBreeze_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">BookBreeze</a></td>
<td><img src="misc/ebook_reader.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
</tbody>
</table>
### 软件分享者
<a href="https://github.com/qianc62"><img src="https://avatars.githubusercontent.com/u/48988402?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/thinkwee"><img src="https://avatars.githubusercontent.com/u/11889052?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/NA-Wen"><img src="https://avatars.githubusercontent.com/u/92134380?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/lijiahao2022"><img src="https://avatars.githubusercontent.com/u/111221887?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/GeekyWizKid"><img src="https://avatars.githubusercontent.com/u/133981481?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
## 📑 引用
@ -334,3 +140,7 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
- ChatDev的使用仅限于研究目的。
- 源代码采用Apache 2.0许可证授权。
- 数据集采用CC BY NC 4.0许可证授权，仅允许非商业用途。请注意，使用这些数据集训练的任何模型不应用于研究以外的其他目的。
## 星标历史
[![Star History Chart](https://api.star-history.com/svg?repos=openbmb/chatdev&type=Date)](https://star-history.com/#openbmb/chatdev&Date)

273
README-Japanese.md
View File

@ -10,32 +10,30 @@
## 📖 概要
- **ChatDev** は、最高経営責任者（CEO）、最高技術責任者（CTO）、プログラマー、テスターなど、さまざまな役割を持つ**インテリジェントエージェント**によって運営される**バーチャルソフトウェア企業**です。これらのエージェントは、マルチエージェントの組織構造を形成し、"プログラミングを通じてデジタル世界に革命を起こす"というミッションで団結しています。ChatDev 内のエージェントは、設計、コーディング、テスト、ドキュメント作成などのタスクを含む専門的な機能セミナーに参加することで、**共同作業** を行います。
- ChatDev の主な目的は、**使いやすく**、**高度にカスタマイズ可能**で**拡張可能**なフレームワークを提供することであり、これは大規模言語モデル（LLM）に基づいており、集合知を研究するための理想的なシナリオとして機能します。
- **ChatDev** は、最高経営責任者（CEO）、最高技術責任者（CTO）、プログラマー、テスターなど、さまざまな役割を持つ**インテリジェントエージェント
**によって運営される**バーチャルソフトウェア企業**です。これらのエージェントは、マルチエージェントの組織構造を形成し、"
プログラミングを通じてデジタル世界に革命を起こす"というミッションで団結しています。ChatDev
内のエージェントは、設計、コーディング、テスト、ドキュメント作成などのタスクを含む専門的な機能セミナーに参加することで、*
*共同作業** を行います。
- ChatDev の主な目的は、**使いやすく**、**高度にカスタマイズ可能**で**拡張可能**
なフレームワークを提供することであり、これは大規模言語モデル（LLM）に基づいており、集合知を研究するための理想的なシナリオとして機能します。
## 📰 ニュース
* **2023年9月1日: Art モードが利用可能になりました！``python3 run.py --config "Art"``。** こちら[example](WareHouse/gomokugameArtExample_THUNLP_20230831122822)を参照してください。
* **2023年9月1日: Art モードが利用可能になりました！``python3 run.py --config "Art"``。**
こちら[example](WareHouse/gomokugameArtExample_THUNLP_20230831122822)を参照してください。
* 2023年8月28日: システムは一般公開されました。
* 2023年8月17日: V1.0.0 のリリース準備が整いました。
* 2023年7月30日: ユーザーは、ChatChain、Phase、Role の設定をカスタマイズすることができます。さらに、オンラインログモードとリプレイモードの両方がサポートされました。
* 2023年7月16日: このプロジェクトに関連した[プレプリント論文](https://arxiv.org/abs/2307.07924)が発表された。
* 2023年6月30日: `ChatDev` リポジトリの初期バージョンがリリースされました。
## ❓ ChatDev は何ができるのか？
![intro](misc/intro.png)
https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9bb62b72
## ⚡️ クイックスタート
開始するには、以下の手順に従ってください:
@ -44,7 +42,8 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
```
git clone https://github.com/OpenBMB/ChatDev.git
```
2. **Python 環境のセットアップ:** バージョン 3.9 以上の Python 環境があることを確認してください。`ChatDev_conda_env` をお好みの環境名に置き換え、以下のコマンドを使用してこの環境を作成し、有効化することができます:
2. **Python 環境のセットアップ:** バージョン 3.9 以上の Python 環境があることを確認してください。`ChatDev_conda_env`
をお好みの環境名に置き換え、以下のコマンドを使用してこの環境を作成し、有効化することができます:
```
conda create -n ChatDev_conda_env python=3.9 -y
conda activate ChatDev_conda_env
@ -54,7 +53,8 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
cd ChatDev
pip3 install -r requirements.txt
```
4. **OpenAI API キーの設定:** OpenAI API key を環境変数としてエクスポートします。`"your_OpenAI_API_key"` を実際の API キーに置き換えてください。この環境変数はセッション固有なので、新しいターミナルセッションを開くときに再度設定する必要があることを覚えておいてください。
4. **OpenAI API キーの設定:** OpenAI API key を環境変数としてエクスポートします。`"your_OpenAI_API_key"` を実際の API
キーに置き換えてください。この環境変数はセッション固有なので、新しいターミナルセッションを開くときに再度設定する必要があることを覚えておいてください。
Unix/Linux 上では:
```
export OPENAI_API_KEY="your_OpenAI_API_key"
@ -63,11 +63,14 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
```
$env:OPENAI_API_KEY="your_OpenAI_API_key"
```
5. **ソフトウェアの構築:** 次のコマンドを使用して、ソフトウェアのビルドを開始する。`[description_of_your_idea]` をあなたのアイデアの説明に、`[project_name]` を希望するプロジェクト名に置き換える:
5. **ソフトウェアの構築:** 次のコマンドを使用して、ソフトウェアのビルドを開始する。`[description_of_your_idea]`
をあなたのアイデアの説明に、`[project_name]` を希望するプロジェクト名に置き換える:
```
python3 run.py --task "[description_of_your_idea]" --name "[project_name]"
```
6. **ソフトウェアの実行:** 生成されたソフトウェアは、`Project_name_DefaultOrganization_timestamp` のような特定のプロジェクトフォルダの下の `WareHouse` ディレクトリにあります。そのディレクトリで以下のコマンドを使ってソフトウェアを実行してください:
6. **ソフトウェアの実行:** 生成されたソフトウェアは、`Project_name_DefaultOrganization_timestamp`
のような特定のプロジェクトフォルダの下の `WareHouse`
ディレクトリにあります。そのディレクトリで以下のコマンドを使ってソフトウェアを実行してください:
```
cd WareHouse/project_name_DefaultOrganization_timestamp
python3 main.py
@ -82,234 +85,40 @@ https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9
- ChatDev フレームワークの概要
- ChatChain 設定の高度なパラメータの包括的な紹介。
- ChatDev をカスタマイズするためのガイドです:
- ChatChain: 独自のソフトウェア開発プロセス（または他のプロセス）を設計します。例えば ``DemandAnalysis -> Coding -> Testing -> Manual`` などです。
- ChatChain:
独自のソフトウェア開発プロセス（または他のプロセス）を設計します。例えば ``DemandAnalysis -> Coding -> Testing -> Manual``
などです。
- Phase: ``DemandAnalysis``のように、ChatChain 内で独自のフェーズを設計する。
- Role: 最高経営責任者 ``Chief Executive Officer`` のように、社内の様々なエージェントを定義する。
## 🤗 ソフトウェアを共有する！
**コード**: 私たちは、あなたが私たちのオープンソースプロジェクトに参加してくださることに熱意をもっています。もし何か問題があれば、遠慮なく報告してください。問い合わせがある場合、または私たちと仕事を共有する用意がある場合は、遠慮なくプルリクエストを作成してください！あなたのコントリビュートは高く評価されます。また、何かありましたらお知らせください！
**コード**:
私たちは、あなたが私たちのオープンソースプロジェクトに参加してくださることに熱意をもっています。もし何か問題があれば、遠慮なく報告してください。問い合わせがある場合、または私たちと仕事を共有する用意がある場合は、遠慮なくプルリクエストを作成してください！あなたのコントリビュートは高く評価されます。また、何かありましたらお知らせください！
**カンパニー**: カスタマイズした "ChatDev Company" の作成は簡単です。このパーソナライズされたセットアップには、3つの簡単な設定JSONファイルが必要です。``CompanyConfig/Default`` ディレクトリで提供されている例をチェックしてください。カスタマイズの詳細については [Wiki](wiki.md) を参照してください。
**カンパニー**: カスタマイズした "ChatDev Company"
の作成は簡単です。このパーソナライズされたセットアップには、3つの簡単な設定JSONファイルが必要です。``CompanyConfig/Default``
ディレクトリで提供されている例をチェックしてください。カスタマイズの詳細については [Wiki](wiki.md) を参照してください。
**ソフトウェア**: ChatDev
を使ってソフトウェアを開発すると、必要な情報を含むフォルダが作成されます。プルリクエストを行うだけで、あなたの作品を共有することができます。コマンド ``python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"``
を実行してください。これでソフトウェアパッケージが作成され、``/WareHouse/2048_THUNLP_timestamp``
という名前のフォルダが生成されます。内部には:
**ソフトウェア**: ChatDev を使ってソフトウェアを開発すると、必要な情報を含むフォルダが作成されます。プルリクエストを行うだけで、あなたの作品を共有することができます。コマンド ``python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"`` を実行してください。これでソフトウェアパッケージが作成され、``/WareHouse/2048_THUNLP_timestamp`` という名前のフォルダが生成されます。内部には:
- 2048 ゲームソフトウェアに関連するすべてのファイルとドキュメント
- ``CompanyConfig/Default`` にある 3 つの JSON 設定ファイルを含む、このソフトウェアを開発した会社の設定ファイル
- リプレイに使用できる、このソフトウェアのビルドプロセスの詳細なログ（``timestamp.log``）
- このソフトウェアを作成するために使用された最初のプロンプト (``2048.prompt``)
ChatDev によって作成された例をいくつか紹介します:
**[ソフトウェア](contribution.md)をコミュニティ製作物を訪れて共有しましょう！**
<table style="width:100%">
<thead>
<tr>
<th>コントリビューター</th>
<th>ソフトウェア</th>
<th>スクリーンショット</th>
<th>ステータス</th>
<th>大規模言語モデル</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4"><a href="https://github.com/qianc62" target="_blank" rel="noopener noreferrer">https://github.com/qianc62</a></td>
<td><a href="WareHouse/Website_THUNLP_20230725154612" target="_blank" rel="noopener noreferrer">A simple website</a></td>
<td><img src="misc/website.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/FlappyBird_THUNLP_20230726121145" target="_blank" rel="noopener noreferrer">FlappyBirds Game</a></td>
<td><img src="misc/flappy_bird.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game</a></td>
<td><img src="misc/gomoku.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Calculator_THUNLP_20230628184918" target="_blank" rel="noopener noreferrer">A calculator with bottom icons generated by Agents</a></td>
<td><img src="misc/calc.jpg" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="17"><a href="https://github.com/thinkwee" target="_blank" rel="noopener noreferrer">https://github.com/thinkwee</a></td>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">Painter</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/pingpong_THUNLP_20230817193956" target="_blank" rel="noopener noreferrer">PingPong Game</a></td>
<td><img src="misc/pingpong.jpg" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelRunner_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">PixelRunner</a></td>
<td><img src="misc/jump_game.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MoneyCtrl_THUNLP_20230825093546" target="_blank" rel="noopener noreferrer">BudgetControl</a></td>
<td><img src="misc/budget.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelCraft_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">PixelCraft</a></td>
<td><img src="misc/pixel_art.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MazeGenerator_THUNLP_20230825093601" target="_blank" rel="noopener noreferrer">MazeGenerator</a></td>
<td><img src="misc/maze_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Matchy_Match_THUNLP_20230825101854" target="_blank" rel="noopener noreferrer">Matchy_Match</a></td>
<td><img src="misc/memory_card_game.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PasswordGenerator_THUNLP_20230825072337" target="_blank" rel="noopener noreferrer">Password Generator</a></td>
<td><img src="misc/password_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ToDo_THUNLP_20230825072331" target="_blank" rel="noopener noreferrer">Todo</a></td>
<td><img src="misc/todo.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ExpenseEase_THUNLP_20230825093604" target="_blank" rel="noopener noreferrer">Expensechart</a></td>
<td><img src="misc/expense_visualizer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/2048_THUNLP_20230822144615" target="_blank" rel="noopener noreferrer">2048 Game</a></td>
<td><img src="misc/2048.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/WordExpand_THUNLP_20230825093623" target="_blank" rel="noopener noreferrer">WordExpand</a></td>
<td><img src="misc/vocab.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Fish_Tycoon_THUNLP_20230825093543" target="_blank" rel="noopener noreferrer">Fish Tycoon</a></td>
<td><img src="misc/aquarium.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DigitalClock_THUNLP_20230825093556" target="_blank" rel="noopener noreferrer">Digital Clock</a></td>
<td><img src="misc/clock.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/CurrencyWiz_THUNLP_20230825101851" target="_blank" rel="noopener noreferrer">CurrencyWiz</a></td>
<td><img src="misc/currency_converter.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DesignDream_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">Design Dream</a></td>
<td><img src="misc/home_design.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DiceRollingSimulator_THUNLP_20230825072338" target="_blank" rel="noopener noreferrer">DiceRollingSimulator</a></td>
<td><img src="misc/dice.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="6"><a href="https://github.com/NA-Wen" target="_blank" rel="noopener noreferrer">https://github.com/NA-Wen</a></td>
<td><a href="WareHouse/md2html_THUNLP_md2html" target="_blank" rel="noopener noreferrer">md2html</a></td>
<td><img src="misc/markdown2html.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game with assets generated by Agent</a></td>
<td><img src="misc/gomoku_art.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/mspaint_THUNLP_20230821204606" target="_blank" rel="noopener noreferrer">MsPaint</a></td>
<td><img src="misc/mspaint.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ImgEditor_THUNLP_20230824142740" target="_blank" rel="noopener noreferrer">Image Editor</a></td>
<td><img src="misc/image_editor.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">ArtCanvas</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/TicTacToe_THUNLP_20230825093547" target="_blank" rel="noopener noreferrer">TicTacToe</a></td>
<td><img src="misc/tictactoe.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="5"><a href="https://github.com/lijiahao2022" target="_blank" rel="noopener noreferrer">https://github.com/lijiahao2022</a></td>
<td><a href="WareHouse/musicplayer_THUNLP_20230824113404" target="_blank" rel="noopener noreferrer">Music Player</a></td>
<td><img src="misc/music_player.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/Typing_THUNLP_20230824105537" target="_blank" rel="noopener noreferrer">Typing Test</a></td>
<td><img src="misc/typing_test.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/videoplayer_THUNLP_20230824233151" target="_blank" rel="noopener noreferrer">Video Player</a></td>
<td><img src="misc/video_player.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/timer_THUNLP_20230823091709" target="_blank" rel="noopener noreferrer">Timer</a></td>
<td><img src="misc/timer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/BookBreeze_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">BookBreeze</a></td>
<td><img src="misc/ebook_reader.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
</tbody>
</table>
### ソフトウェア共有者
<a href="https://github.com/qianc62"><img src="https://avatars.githubusercontent.com/u/48988402?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/thinkwee"><img src="https://avatars.githubusercontent.com/u/11889052?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/NA-Wen"><img src="https://avatars.githubusercontent.com/u/92134380?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/lijiahao2022"><img src="https://avatars.githubusercontent.com/u/111221887?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/GeekyWizKid"><img src="https://avatars.githubusercontent.com/u/133981481?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
## 📑 引用
@ -329,3 +138,7 @@ ChatDev によって作成された例をいくつか紹介します:
- ChatDev の目的は研究目的のみです。
- ソースコードは Apache 2.0 でライセンスされています。
- データセットのライセンスは CC BY NC 4.0 であり、非商用目的でのみ使用できる。これらのデータセットを使用して学習されたモデルは、研究以外の目的で使用されないようご注意ください。
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=openbmb/chatdev&type=Date)](https://star-history.com/#openbmb/chatdev&Date)

289
README.md
View File

@ -10,32 +10,31 @@
## 📖 Overview
- **ChatDev** stands as a **virtual software company** that operates through various **intelligent agents** holding different roles, including Chief Executive Officer, Chief Technology Officer, Programmer, Tester, and more. These agents form a multi-agent organizational structure and are united by a mission to "revolutionize the digital world through programming." The agents within ChatDev **collaborate** by participating in specialized functional seminars, including tasks such as designing, coding, testing, and documenting.
- The primary objective of ChatDev is to offer an **easy-to-use**, **highly customizable** and **extendable** framework, which is based on large language models (LLMs) and serves as an ideal scenario for studying collective intelligence.
- **ChatDev** stands as a **virtual software company** that operates through various **intelligent agents** holding
different roles, including Chief Executive Officer, Chief Technology Officer, Programmer, Tester, and more. These
agents form a multi-agent organizational structure and are united by a mission to "revolutionize the digital world
through programming." The agents within ChatDev **collaborate** by participating in specialized functional seminars,
including tasks such as designing, coding, testing, and documenting.
- The primary objective of ChatDev is to offer an **easy-to-use**, **highly customizable** and **extendable** framework,
which is based on large language models (LLMs) and serves as an ideal scenario for studying collective intelligence.
## 📰 News
* **September 1, 2023: The Art mode is available now! You can use agent to generate images used in the software, try ``python3 run.py --config "Art"``.** See [example](WareHouse/gomokugameArtExample_THUNLP_20230831122822) here.
* **September 1, 2023: The Art mode is available now! You can use agent to generate images used in the software,
try ``python3 run.py --config "Art"``.** See [example](WareHouse/gomokugameArtExample_THUNLP_20230831122822) here.
* August 28, 2023: The system is publicly available.
* August 17, 2023: The V1.0.0 version was ready for release.
* July 30, 2023: Users can customize ChatChain, Phase, and Role settings. Additionally, both online Log mode and replay mode are now supported.
* July 30, 2023: Users can customize ChatChain, Phase, and Role settings. Additionally, both online Log mode and replay
mode are now supported.
* July 16, 2023: The [preprint paper](https://arxiv.org/abs/2307.07924) associated with this project was published.
* June 30, 2023: The initial version of the `ChatDev` repository was released.
## ❓ What Can ChatDev Do?
![intro](misc/intro.png)
https://github.com/OpenBMB/ChatDev/assets/11889052/80d01d2f-677b-4399-ad8b-f7af9bb62b72
## ⚡️ Quickstart
To get started, follow these steps:
@ -44,7 +43,9 @@ To get started, follow these steps:
```
git clone https://github.com/OpenBMB/ChatDev.git
```
2. **Set Up Python Environment:** Ensure you have a version 3.9 or higher Python environment. You can create and activate this environment using the following commands, replacing `ChatDev_conda_env` with your preferred environment name:
2. **Set Up Python Environment:** Ensure you have a version 3.9 or higher Python environment. You can create and
activate this environment using the following commands, replacing `ChatDev_conda_env` with your preferred environment
name:
```
conda create -n ChatDev_conda_env python=3.9 -y
conda activate ChatDev_conda_env
@ -54,7 +55,9 @@ To get started, follow these steps:
cd ChatDev
pip3 install -r requirements.txt
```
4. **Set OpenAI API Key:** Export your OpenAI API key as an environment variable. Replace `"your_OpenAI_API_key"` with your actual API key. Remember that this environment variable is session-specific, so you need to set it again if you open a new terminal session.
4. **Set OpenAI API Key:** Export your OpenAI API key as an environment variable. Replace `"your_OpenAI_API_key"` with
your actual API key. Remember that this environment variable is session-specific, so you need to set it again if you
open a new terminal session.
On Unix/Linux:
```
export OPENAI_API_KEY="your_OpenAI_API_key"
@ -63,11 +66,15 @@ To get started, follow these steps:
```
$env:OPENAI_API_KEY="your_OpenAI_API_key"
```
5. **Build Your Software:** Use the following command to initiate the building of your software, replacing `[description_of_your_idea]` with your idea's description and `[project_name]` with your desired project name:
5. **Build Your Software:** Use the following command to initiate the building of your software,
replacing `[description_of_your_idea]` with your idea's description and `[project_name]` with your desired project
name:
```
python3 run.py --task "[description_of_your_idea]" --name "[project_name]"
```
6. **Run Your Software:** Once generated, you can find your software in the `WareHouse` directory under a specific project folder, such as `project_name_DefaultOrganization_timestamp`. Run your software using the following command within that directory:
6. **Run Your Software:** Once generated, you can find your software in the `WareHouse` directory under a specific
project folder, such as `project_name_DefaultOrganization_timestamp`. Run your software using the following command
within that directory:
```
cd WareHouse/project_name_DefaultOrganization_timestamp
python3 main.py
@ -78,238 +85,47 @@ To get started, follow these steps:
For more detailed information, please refer to our [Wiki](wiki.md), where you can find:
- An introduction to all command run parameters.
- A straightforward guide for setting up a local web demo, which includes enhanced visualized logs, a replay demo, and a simple ChatChain Visualizer.
- A straightforward guide for setting up a local web demo, which includes enhanced visualized logs, a replay demo, and a
simple ChatChain Visualizer.
- An overview of the ChatDev framework.
- A comprehensive introduction to all advanced parameters in ChatChain configuration.
- Guides for customizing ChatDev, including:
- ChatChain: Design your own software development process (or any other process), such as ``DemandAnalysis -> Coding -> Testing -> Manual``.
- ChatChain: Design your own software development process (or any other process), such
as ``DemandAnalysis -> Coding -> Testing -> Manual``.
- Phase: Design your own phase within ChatChain, like ``DemandAnalysis``.
- Role: Defining the various agents in your company, such as the ``Chief Executive Officer``.
## 🤗 Share Your Software!
**Code**: We are enthusiastic about your interest in participating in our open-source project. If you come across any problems, don't hesitate to report them. Feel free to create a pull request if you have any inquiries or if you are prepared to share your work with us! Your contributions are highly valued. Please let me know if there's anything else you need assistance!
**Code**: We are enthusiastic about your interest in participating in our open-source project. If you come across any
problems, don't hesitate to report them. Feel free to create a pull request if you have any inquiries or if you are
prepared to share your work with us! Your contributions are highly valued. Please let me know if there's anything else
you need assistance!
**Company**: Creating your own customized "ChatDev Company" is a breeze. This personalized setup involves three simple configuration JSON files. Check out the example provided in the ``CompanyConfig/Default`` directory. For detailed instructions on customization, refer to our [Wiki](wiki.md).
**Company**: Creating your own customized "ChatDev Company" is a breeze. This personalized setup involves three simple
configuration JSON files. Check out the example provided in the ``CompanyConfig/Default`` directory. For detailed
instructions on customization, refer to our [Wiki](wiki.md).
**Software**: Whenever you develop software using ChatDev, a corresponding folder is generated containing all the
essential information. Sharing your work with us is as simple as making a pull request. Here's an example: execute the
command ``python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"``. This will
create a software package and generate a folder named ``/WareHouse/2048_THUNLP_timestamp``. Inside, you'll find:
**Software**: Whenever you develop software using ChatDev, a corresponding folder is generated containing all the essential information. Sharing your work with us is as simple as making a pull request. Here's an example: execute the command ``python3 run.py --task "design a 2048 game" --name "2048" --org "THUNLP" --config "Default"``. This will create a software package and generate a folder named ``/WareHouse/2048_THUNLP_timestamp``. Inside, you'll find:
- All the files and documents related to the 2048 game software
- Configuration files of the company responsible for this software, including the three JSON config files from ``CompanyConfig/Default``
- Configuration files of the company responsible for this software, including the three JSON config files
from ``CompanyConfig/Default``
- A comprehensive log detailing the software's building process that can be used to replay (``timestamp.log``)
- The initial prompt used to create this software (``2048.prompt``)
Here are some examples created by ChatDev:
**See Community contributed software [here](contribution.md)!**
<table style="width:100%">
<thead>
<tr>
<th>Contributor</th>
<th>Software</th>
<th>ScreenShot</th>
<th>Status</th>
<th>LLM</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4"><a href="https://github.com/qianc62" target="_blank" rel="noopener noreferrer">https://github.com/qianc62</a></td>
<td><a href="WareHouse/Website_THUNLP_20230725154612" target="_blank" rel="noopener noreferrer">A simple website</a></td>
<td><img src="misc/website.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/FlappyBird_THUNLP_20230726121145" target="_blank" rel="noopener noreferrer">FlappyBirds Game</a></td>
<td><img src="misc/flappy_bird.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game</a></td>
<td><img src="misc/gomoku.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Calculator_THUNLP_20230628184918" target="_blank" rel="noopener noreferrer">A calculator with bottom icons generated by Agents</a></td>
<td><img src="misc/calc.jpg" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="17"><a href="https://github.com/thinkwee" target="_blank" rel="noopener noreferrer">https://github.com/thinkwee</a></td>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">Painter</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/pingpong_THUNLP_20230817193956" target="_blank" rel="noopener noreferrer">PingPong Game</a></td>
<td><img src="misc/pingpong.jpg" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelRunner_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">PixelRunner</a></td>
<td><img src="misc/jump_game.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MoneyCtrl_THUNLP_20230825093546" target="_blank" rel="noopener noreferrer">BudgetControl</a></td>
<td><img src="misc/budget.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PixelCraft_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">PixelCraft</a></td>
<td><img src="misc/pixel_art.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/MazeGenerator_THUNLP_20230825093601" target="_blank" rel="noopener noreferrer">MazeGenerator</a></td>
<td><img src="misc/maze_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Matchy_Match_THUNLP_20230825101854" target="_blank" rel="noopener noreferrer">Matchy_Match</a></td>
<td><img src="misc/memory_card_game.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/PasswordGenerator_THUNLP_20230825072337" target="_blank" rel="noopener noreferrer">Password Generator</a></td>
<td><img src="misc/password_generator.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ToDo_THUNLP_20230825072331" target="_blank" rel="noopener noreferrer">Todo</a></td>
<td><img src="misc/todo.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ExpenseEase_THUNLP_20230825093604" target="_blank" rel="noopener noreferrer">Expensechart</a></td>
<td><img src="misc/expense_visualizer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/2048_THUNLP_20230822144615" target="_blank" rel="noopener noreferrer">2048 Game</a></td>
<td><img src="misc/2048.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/WordExpand_THUNLP_20230825093623" target="_blank" rel="noopener noreferrer">WordExpand</a></td>
<td><img src="misc/vocab.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Fish_Tycoon_THUNLP_20230825093543" target="_blank" rel="noopener noreferrer">Fish Tycoon</a></td>
<td><img src="misc/aquarium.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DigitalClock_THUNLP_20230825093556" target="_blank" rel="noopener noreferrer">Digital Clock</a></td>
<td><img src="misc/clock.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/CurrencyWiz_THUNLP_20230825101851" target="_blank" rel="noopener noreferrer">CurrencyWiz</a></td>
<td><img src="misc/currency_converter.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DesignDream_THUNLP_20230825072340" target="_blank" rel="noopener noreferrer">Design Dream</a></td>
<td><img src="misc/home_design.png" width="200px"></td>
<td>Biased</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/DiceRollingSimulator_THUNLP_20230825072338" target="_blank" rel="noopener noreferrer">DiceRollingSimulator</a></td>
<td><img src="misc/dice.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="6"><a href="https://github.com/NA-Wen" target="_blank" rel="noopener noreferrer">https://github.com/NA-Wen</a></td>
<td><a href="WareHouse/md2html_THUNLP_md2html" target="_blank" rel="noopener noreferrer">md2html</a></td>
<td><img src="misc/markdown2html.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/Gomoku_THUNLP_20230625201030" target="_blank" rel="noopener noreferrer">A Gomoku Game with assets generated by Agent</a></td>
<td><img src="misc/gomoku_art.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/mspaint_THUNLP_20230821204606" target="_blank" rel="noopener noreferrer">MsPaint</a></td>
<td><img src="misc/mspaint.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ImgEditor_THUNLP_20230824142740" target="_blank" rel="noopener noreferrer">Image Editor</a></td>
<td><img src="misc/image_editor.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/ArtCanvas_THUNLP_20230825093558" target="_blank" rel="noopener noreferrer">ArtCanvas</a></td>
<td><img src="misc/paint.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/TicTacToe_THUNLP_20230825093547" target="_blank" rel="noopener noreferrer">TicTacToe</a></td>
<td><img src="misc/tictactoe.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td rowspan="5"><a href="https://github.com/lijiahao2022" target="_blank" rel="noopener noreferrer">https://github.com/lijiahao2022</a></td>
<td><a href="WareHouse/musicplayer_THUNLP_20230824113404" target="_blank" rel="noopener noreferrer">Music Player</a></td>
<td><img src="misc/music_player.png" width="200px"></td>
<td>Perfect</td>
<td>GPT4</td>
</tr>
<tr>
<td><a href="WareHouse/Typing_THUNLP_20230824105537" target="_blank" rel="noopener noreferrer">Typing Test</a></td>
<td><img src="misc/typing_test.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/videoplayer_THUNLP_20230824233151" target="_blank" rel="noopener noreferrer">Video Player</a></td>
<td><img src="misc/video_player.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/timer_THUNLP_20230823091709" target="_blank" rel="noopener noreferrer">Timer</a></td>
<td><img src="misc/timer.png" width="200px"></td>
<td>Perfect</td>
<td>GPT3.5</td>
</tr>
<tr>
<td><a href="WareHouse/BookBreeze_THUNLP_20230825072339" target="_blank" rel="noopener noreferrer">BookBreeze</a></td>
<td><img src="misc/ebook_reader.png" width="200px"></td>
<td>Runnable</td>
<td>GPT3.5</td>
</tr>
</tbody>
</table>
### Software Contributors
<a href="https://github.com/qianc62"><img src="https://avatars.githubusercontent.com/u/48988402?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/thinkwee"><img src="https://avatars.githubusercontent.com/u/11889052?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/NA-Wen"><img src="https://avatars.githubusercontent.com/u/92134380?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/lijiahao2022"><img src="https://avatars.githubusercontent.com/u/111221887?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
<a href="https://github.com/GeekyWizKid"><img src="https://avatars.githubusercontent.com/u/133981481?v=4" alt="Contributor" style="width:5%; border-radius: 50%;"/></a>
## 📑 Citation
@ -328,4 +144,9 @@ Here are some examples created by ChatDev:
- The purpose of ChatDev is exclusively for research purposes.
- The source code is licensed under Apache 2.0.
- The datasets are licensed under CC BY NC 4.0, which allows for non-commercial use only. It is important to note that any models trained using these datasets should not be employed for purposes other than research.
- The datasets are licensed under CC BY NC 4.0, which allows for non-commercial use only. It is important to note that
any models trained using these datasets should not be employed for purposes other than research.
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=openbmb/chatdev&type=Date)](https://star-history.com/#openbmb/chatdev&Date)

BIN
misc/tiny_rogue.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 174 KiB