Merge branch 'modelscope:main' into main

modelscope · Sep 23, 2024 · ca23ad8 · ca23ad8
2 parents f16bb65 + fbd0e11
commit ca23ad8
Show file tree

Hide file tree

Showing 11 changed files with 216 additions and 93 deletions.
diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
@@ -24,9 +24,9 @@ jobs:
     - name: Install Minimal Dependencies
       run: |
         pip install -q -e .
-    - name: Run import tests
+    - name: Run minimal import tests
       run: |
-        python -c "import agentscope; print(agentscope.__version__)"
+        python tests/minimal.py
     - name: Install Full Dependencies
       run: |
         pip install -q -e .[full]

diff --git a/README.md b/README.md
@@ -35,7 +35,6 @@ Start building LLM-empowered multi-agent applications in an easier way.
 |----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
 | <img src="https://gw.alicdn.com/imgextra/i1/O1CN01hhD1mu1Dd3BWVUvxN_!!6000000000238-2-tps-400-400.png" width="100" height="100"> | <img src="https://img.alicdn.com/imgextra/i2/O1CN01tuJ5971OmAqNg9cOw_!!6000000001747-0-tps-444-460.jpg" width="100" height="100"> |
 
-
 ----
 
 ## News
@@ -187,7 +186,6 @@ the following libraries.
   - <img src="https://img.alicdn.com/imgextra/i3/O1CN01SFL0Gu26nrQBFKXFR_!!6000000007707-2-tps-500-500.png" alt="new" width="30" height="30"/>[Conversation with CodeAct Agent](https://github.com/modelscope/agentscope/blob/main/examples/conversation_with_codeact_agent/)
   - <img src="https://img.alicdn.com/imgextra/i3/O1CN01SFL0Gu26nrQBFKXFR_!!6000000007707-2-tps-500-500.png" alt="new" width="30" height="30"/>[Conversation with Router Agent](https://github.com/modelscope/agentscope/blob/main/examples/conversation_with_router_agent/)
 
-
 - Game
   - [Gomoku](https://github.com/modelscope/agentscope/blob/main/examples/game_gomoku)
   - [Werewolf](https://github.com/modelscope/agentscope/blob/main/examples/game_werewolf)
@@ -236,7 +234,6 @@ optional dependencies. Full list of optional dependencies refers to
 Taking distribution mode as an example, you can install its dependencies
 as follows:
 
-
 #### On Windows
 
 ```bash
@@ -247,14 +244,14 @@ pip install agentscope[distribute]
 ```
 
 #### On Mac & Linux
+
 ```bash
 # From source
 pip install -e .\[distribute\]
 # From pypi
 pip install agentscope\[distribute\]
 ```
 
-
 ## Quick Start
 
 ### Configuration
@@ -391,35 +388,70 @@ pre-commit install
 
 Please refer to our [Contribution Guide](https://modelscope.github.io/agentscope/en/tutorial/302-contribute.html) for more details.
 
-## References
-
-If you find our work helpful for your research or application, please
-cite [our paper](https://arxiv.org/abs/2402.14034):
-
-```
-@article{agentscope,
-  author  = {Dawei Gao and
-             Zitao Li and
-             Xuchen Pan and
-             Weirui Kuang and
-             Zhijian Ma and
-             Bingchen Qian and
-             Fei Wei and
-             Wenhao Zhang and
-             Yuexiang Xie and
-             Daoyuan Chen and
-             Liuyi Yao and
-             Hongyi Peng and
-             Ze Yu Zhang and
-             Lin Zhu and
-             Chen Cheng and
-             Hongzhu Shi and
-             Yaliang Li and
-             Bolin Ding and
-             Jingren Zhou},
-  title   = {AgentScope: A Flexible yet Robust Multi-Agent Platform},
-  journal = {CoRR},
-  volume  = {abs/2402.14034},
-  year    = {2024},
-}
-```
+## Publications
+
+If you find our work helpful for your research or application, please cite our papers.
+
+1. [AgentScope: A Flexible yet Robust Multi-Agent Platform](https://arxiv.org/abs/2402.14034)
+
+    ```
+    @article{agentscope,
+        author  = {Dawei Gao and
+                   Zitao Li and
+                   Xuchen Pan and
+                   Weirui Kuang and
+                   Zhijian Ma and
+                   Bingchen Qian and
+                   Fei Wei and
+                   Wenhao Zhang and
+                   Yuexiang Xie and
+                   Daoyuan Chen and
+                   Liuyi Yao and
+                   Hongyi Peng and
+                   Ze Yu Zhang and
+                   Lin Zhu and
+                   Chen Cheng and
+                   Hongzhu Shi and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Jingren Zhou}
+        title   = {AgentScope: A Flexible yet Robust Multi-Agent Platform},
+        journal = {CoRR},
+        volume  = {abs/2402.14034},
+        year    = {2024},
+    }
+    ```
+
+2. [On the Design and Analysis of LLM-Based Algorithms](https://arxiv.org/abs/2407.14788)
+
+    ```
+    @article{llm_based_algorithms,
+        author  = {Yanxi Chen and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Jingren Zhou},
+        title   = {On the Design and Analysis of LLM-Based Algorithms},
+        journal = {CoRR},
+        volume  = {abs/2407.14788},
+        year    = {2024},
+    }
+    ```
+
+3. [Very Large-Scale Multi-Agent Simulation in AgentScope](https://arxiv.org/abs/2407.17789)
+
+    ```
+    @article{agentscope_simulation,
+        author  = {Xuchen Pan and
+                   Dawei Gao and
+                   Yuexiang Xie and
+                   Zhewei Wei and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Ji{-}Rong Wen and
+                   Jingren Zhou},
+        title   = {Very Large-Scale Multi-Agent Simulation in AgentScope},
+        journal = {CoRR},
+        volume  = {abs/2407.17789},
+        year    = {2024},
+    }
+    ```
diff --git a/README_ZH.md b/README_ZH.md
@@ -35,8 +35,6 @@
 |---------|----------|
 | <img src="https://gw.alicdn.com/imgextra/i1/O1CN01hhD1mu1Dd3BWVUvxN_!!6000000000238-2-tps-400-400.png" width="100" height="100"> | <img src="https://img.alicdn.com/imgextra/i2/O1CN01tuJ5971OmAqNg9cOw_!!6000000001747-0-tps-444-460.jpg" width="100" height="100"> |
 
-
-
 ----
 
 ## 新闻
@@ -56,7 +54,6 @@
 <img src="https://github.com/user-attachments/assets/dfffbd1e-1fe7-49ee-ac11-902415b2b0d6" width="45%" alt="agentscope-logo">
 </h5>
 
-
 - <img src="https://img.alicdn.com/imgextra/i3/O1CN01SFL0Gu26nrQBFKXFR_!!6000000007707-2-tps-500-500.png" alt="new" width="30" height="30"/>**[2024-07-15]** AgentScope 中添加了 Mixture of Agents 算法。使用样例请参考 [MoA 示例](https://github.com/modelscope/agentscope/blob/main/examples/conversation_mixture_of_agents)。
 
 - **[2024-06-14]** 新的提示调优（Prompt tuning）模块已经上线 AgentScope，用以帮助开发者生成和优化智能体的 system prompt。更多的细节和使用样例请参考 AgentScope [教程](https://modelscope.github.io/agentscope/en/tutorial/209-prompt_opt.html)！
@@ -232,6 +229,7 @@ pip install agentscope[distribute]
 ```
 
 #### On Mac & Linux
+
 ```bash
 # From source
 pip install -e .\[distribute\]
@@ -362,34 +360,70 @@ pre-commit install
 
 请参阅我们的[贡献指南](https://modelscope.github.io/agentscope/zh_CN/tutorial/302-contribute.html)了解更多细节。
 
-## 引用
-
-如果您觉得我们的工作对您的研究或应用有帮助，请引用[我们的论文](https://arxiv.org/abs/2402.14034)。
-
-```
-@article{agentscope,
-  author  = {Dawei Gao and
-             Zitao Li and
-             Xuchen Pan and
-             Weirui Kuang and
-             Zhijian Ma and
-             Bingchen Qian and
-             Fei Wei and
-             Wenhao Zhang and
-             Yuexiang Xie and
-             Daoyuan Chen and
-             Liuyi Yao and
-             Hongyi Peng and
-             Zeyu Zhang and
-             Lin Zhu and
-             Chen Cheng and
-             Hongzhu Shi and
-             Yaliang Li and
-             Bolin Ding and
-             Jingren Zhou},
-  title   = {AgentScope: A Flexible yet Robust Multi-Agent Platform},
-  journal = {CoRR},
-  volume  = {abs/2402.14034},
-  year    = {2024},
-}
-```
+## 发表
+
+如果您觉得我们的工作对您的研究或应用有帮助，请引用如下论文
+
+1. [AgentScope: A Flexible yet Robust Multi-Agent Platform](https://arxiv.org/abs/2402.14034)
+
+    ```
+    @article{agentscope,
+        author  = {Dawei Gao and
+                   Zitao Li and
+                   Xuchen Pan and
+                   Weirui Kuang and
+                   Zhijian Ma and
+                   Bingchen Qian and
+                   Fei Wei and
+                   Wenhao Zhang and
+                   Yuexiang Xie and
+                   Daoyuan Chen and
+                   Liuyi Yao and
+                   Hongyi Peng and
+                   Ze Yu Zhang and
+                   Lin Zhu and
+                   Chen Cheng and
+                   Hongzhu Shi and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Jingren Zhou}
+        title   = {AgentScope: A Flexible yet Robust Multi-Agent Platform},
+        journal = {CoRR},
+        volume  = {abs/2402.14034},
+        year    = {2024},
+    }
+    ```
+
+2. [On the Design and Analysis of LLM-Based Algorithms](https://arxiv.org/abs/2407.14788)
+
+    ```
+    @article{llm_based_algorithms,
+        author  = {Yanxi Chen and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Jingren Zhou},
+        title   = {On the Design and Analysis of LLM-Based Algorithms},
+        journal = {CoRR},
+        volume  = {abs/2407.14788},
+        year    = {2024},
+    }
+    ```
+
+3. [Very Large-Scale Multi-Agent Simulation in AgentScope](https://arxiv.org/abs/2407.17789)
+
+    ```
+    @article{agentscope_simulation,
+        author  = {Xuchen Pan and
+                   Dawei Gao and
+                   Yuexiang Xie and
+                   Zhewei Wei and
+                   Yaliang Li and
+                   Bolin Ding and
+                   Ji{-}Rong Wen and
+                   Jingren Zhou},
+        title   = {Very Large-Scale Multi-Agent Simulation in AgentScope},
+        journal = {CoRR},
+        volume  = {abs/2407.17789},
+        year    = {2024},
+    }
+    ```
diff --git a/docs/sphinx_doc/en/source/tutorial/104-usecase.md b/docs/sphinx_doc/en/source/tutorial/104-usecase.md
@@ -291,7 +291,7 @@ With the game logic and agents set up, you're ready to run the Werewolf game. By
 
 ```bash
 cd examples/game_werewolf
-python main.py  # Assuming the pipeline is implemented in main.py
+python werewolf.py  # Assuming the pipeline is implemented in werewolf.py
 ```
 
 It is recommended that you start the game in [AgentScope Studio](https://modelscope.github.io/agentscope/en/tutorial/209-gui.html), where you

diff --git a/docs/sphinx_doc/zh_CN/source/tutorial/104-usecase.md b/docs/sphinx_doc/zh_CN/source/tutorial/104-usecase.md
@@ -170,7 +170,7 @@ for i in range(1, MAX_GAME_ROUND + 1):
     # Night phase: werewolves discuss
     hint = HostMsg(content=Prompts.to_wolves.format(n2s(wolves)))
     with msghub(wolves, announcement=hint) as hub:
-      	set_parsers(wolves, Prompts.wolves_discuss_parser)
+        set_parsers(wolves, Prompts.wolves_discuss_parser)
         for _ in range(MAX_WEREWOLF_DISCUSSION_ROUND):
             x = sequentialpipeline(wolves)
             if x.metadata.get("finish_discussion", False):
@@ -295,7 +295,7 @@ for i in range(1, MAX_GAME_ROUND + 1):
 
 ```bash
 cd examples/game_werewolf
-python main.py  # Assuming the pipeline is implemented in main.py
+python werewolf.py  # Assuming the pipeline is implemented in werewolf.py
 ```
 
 建议您在在 [AgentScope Studio](https://modelscope.github.io/agentscope/zh_CN/tutorial/209-gui.html) 中启动游戏，在对应的链接中您将看到下面的内容输出。

diff --git a/docs/sphinx_doc/zh_CN/source/tutorial/209-gui.md b/docs/sphinx_doc/zh_CN/source/tutorial/209-gui.md
@@ -70,7 +70,7 @@ agentscope.init(
     # ...
     project="xxx",
     name="xxx",
-    studio_url="http://127.0.0.1：5000"          # AgentScope Studio 的 URL
+    studio_url="http://127.0.0.1:5000"          # AgentScope Studio 的 URL
 )
 ```