From 62bb5d8195186dbed281535440fe0d9eb8598114 Mon Sep 17 00:00:00 2001 From: zyzhang1130 <36942574+zyzhang1130@users.noreply.github.com> Date: Fri, 7 Jun 2024 17:30:33 +0800 Subject: [PATCH] Reformat the README file of the example `distributed_basic` (#277) --- README.md | 2 +- README_ZH.md | 2 +- .../README.md | 26 +++++++++++++++---- .../configs/model_configs.json | 0 .../distributed_dialog.py | 0 5 files changed, 23 insertions(+), 7 deletions(-) rename examples/{distributed_basic => distributed_conversation}/README.md (54%) rename examples/{distributed_basic => distributed_conversation}/configs/model_configs.json (100%) rename examples/{distributed_basic => distributed_conversation}/distributed_dialog.py (100%) diff --git a/README.md b/README.md index d0abc1d24..839717c5c 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ the following libraries. - [Werewolf](https://github.com/modelscope/agentscope/blob/main/examples/game_werewolf) - Distribution - - [Distributed Conversation](https://github.com/modelscope/agentscope/blob/main/examples/distributed_basic) + - [Distributed Conversation](https://github.com/modelscope/agentscope/blob/main/examples/distributed_conversation) - [Distributed Debate](https://github.com/modelscope/agentscope/blob/main/examples/distributed_debate) - [Distributed Parallel Search](https://github.com/modelscope/agentscope/blob/main/examples/distributed_search) - [Distributed Large Scale Simulation](https://github.com/modelscope/agentscope/blob/main/examples/distributed_simulation) diff --git a/README_ZH.md b/README_ZH.md index 068d687fc..45889757d 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -134,7 +134,7 @@ AgentScope支持使用以下库快速部署本地模型服务。 - [狼人杀](./examples/game_werewolf) - 分布式 - - [分布式对话](./examples/distributed_basic) + - [分布式对话](./examples/distributed_conversation) - [分布式辩论](./examples/distributed_debate) - [分布式并行搜索](./examples/distributed_search) - [分布式大规模仿真](./examples/distributed_simulation) diff --git a/examples/distributed_basic/README.md b/examples/distributed_conversation/README.md similarity index 54% rename from examples/distributed_basic/README.md rename to examples/distributed_conversation/README.md index 1ee3e4d86..b58584370 100644 --- a/examples/distributed_basic/README.md +++ b/examples/distributed_conversation/README.md @@ -1,10 +1,26 @@ -# Distributed Basic +# Distributed Conversation -This example run a assistant agent and a user agent as separate processes and use rpc to communicate between them. +This example will show +- How to set up and run a distributed conversation. +- How to configure and use different language models in the system. + +## Background + +This example demonstrates a distributed dialog system leveraging various language models. The system is designed to handle conversational AI tasks in a distributed manner, allowing for scalable and efficient dialog management. + +## Tested Models + +These models are tested in this example. For other models, some modifications may be needed. +- Ollama Chat (llama3_8b) +- Dashscope Chat (qwen-Max) +- Gemini Chat (gemini-pro) + +## Prerequisites Before running the example, please install the distributed version of Agentscope, fill in your model configuration correctly in `configs/model_configs.json`, and modify the `model_config_name` field in `distributed_dialog.py` accordingly. -Then, use the following command to start the assistant agent. +## Running the Example +Use the following command to start the assistant agent: ``` cd examples/distributed_basic @@ -14,7 +30,7 @@ python distributed_dialog.py --role assistant --assistant-host localhost --assis # please fill in the ip address of the assistant agent in the host field ``` -Then, run the user agent. +Then, run the user agent: ``` python distributed_dialog.py --role user --assistant-host localhost --assistant-port 12010 @@ -22,4 +38,4 @@ python distributed_dialog.py --role user --assistant-host localhost --assistant- # please fill in the ip address of the assistant agent in the host field ``` -Now, you can chat with the assistant agent using the command line. +Now, you can chat with the assistant agent using the command line. \ No newline at end of file diff --git a/examples/distributed_basic/configs/model_configs.json b/examples/distributed_conversation/configs/model_configs.json similarity index 100% rename from examples/distributed_basic/configs/model_configs.json rename to examples/distributed_conversation/configs/model_configs.json diff --git a/examples/distributed_basic/distributed_dialog.py b/examples/distributed_conversation/distributed_dialog.py similarity index 100% rename from examples/distributed_basic/distributed_dialog.py rename to examples/distributed_conversation/distributed_dialog.py