Update readme (#79)
* update readme * update deepwiki badge * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
96
README.md
96
README.md
@@ -1,60 +1,45 @@
|
|||||||
# AgentScope Sample Agents
|
# AgentScope Samples
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
||||||
[](#contributors-)
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
||||||
[](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE)
|
[](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE)
|
||||||
[](https://www.python.org/)
|
[](https://www.python.org/)
|
||||||
|
[](https://deepwiki.com/agentscope-ai/agentscope-samples)
|
||||||
[](https://doc.agentscope.io/)
|
[](https://doc.agentscope.io/)
|
||||||
[](https://runtime.agentscope.io/)
|
[](https://runtime.agentscope.io/)
|
||||||
[](https://github.com/agentscope-ai/agentscope-samples)
|
[](https://github.com/agentscope-ai/agentscope-samples)
|
||||||
|
|
||||||
[[中文README]](README_zh.md)
|
[[中文README]](README_zh.md)
|
||||||
|
|
||||||
Welcome to the **AgentScope Sample Agents** repository! 🎯
|
🎯 **Kickstart Your Agent Journey!**
|
||||||
This repository provides **ready-to-use Python sample agents** built on top of:
|
This is a repository that **brings together a variety of ready-to-run Python agent examples**, ranging from command-line mini-tools to **full-stack deployable applications**.
|
||||||
|
|
||||||
- [AgentScope](https://github.com/agentscope-ai/agentscope)
|
## 🌟 What is AgentScope?
|
||||||
- [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime)
|
|
||||||
|
|
||||||
The examples cover a wide range of use cases — from lightweight command-line agents to **full-stack deployable applications** with both backend and frontend.
|
**[AgentScope](https://github.com/agentscope-ai/agentscope)** is a **multi-agent framework** that lets you rapidly build **LLM-based intelligent applications**:
|
||||||
|
|
||||||
------
|
> Learn more in the [AgentScope Documentation](https://doc.agentscope.io/)
|
||||||
|
|
||||||
## 📖 About AgentScope & AgentScope Runtime
|
- 🧠 Define agents and integrate tools
|
||||||
|
- 📡 Manage context and conversations
|
||||||
|
- 🤝 Orchestrate collaboration among multiple agents to accomplish tasks
|
||||||
|
|
||||||
### **AgentScope**
|
|
||||||
|
|
||||||
AgentScope is a multi-agent framework designed to provide a **simple and efficient** way to build **LLM-powered agent applications**. It offers abstractions for defining agents, integrating tools, managing conversations, and orchestrating multi-agent workflows.
|
|
||||||
|
|
||||||
### **AgentScope Runtime**
|
**[AgentScope-Runtime](https://github.com/agentscope-ai/agentscope-runtime)** is the runtime framework that enables you to deploy agents as API services:
|
||||||
|
|
||||||
AgentScope Runtime is a **comprehensive runtime framework** that addresses two key challenges in deploying and operating agents:
|
> Learn more in the [AgentScope Runtime Documentation](https://runtime.agentscope.io/)
|
||||||
|
|
||||||
1. **Effective Agent Deployment** – Scalable deployment and management of agents across environments.
|
1. 🔄 **Scalable deployment management for multiple agents**
|
||||||
2. **Sandboxed Tool Execution** – Secure, isolated execution of tools and external actions.
|
2. 🛡️ **Secure sandbox execution for tools**
|
||||||
|
|
||||||
It includes **agent deployment** and **secure sandboxed tool execution**, and can be used with **AgentScope** or other agent frameworks.
|
## ⚡ Getting Started
|
||||||
|
|
||||||
------
|
📌 **Before running an example**, please check the corresponding `README.md` for installation and execution instructions.
|
||||||
|
|
||||||
## ✨ Getting Started
|
> - All examples are built with **Python**.
|
||||||
|
> - Examples are organized by **functionality** and **usage scenario**.
|
||||||
- All samples are **Python-based**.
|
> - Some examples use **AgentScope** only.
|
||||||
- Samples are organized **by functional use case**.
|
> - Some examples use **both AgentScope and AgentScope Runtime** to implement **deployable full-stack applications with frontend + backend**.
|
||||||
- Some samples use only **AgentScope** (pure Python agents).
|
> - Full-stack runtime versions have folder names ending with **`_fullstack_runtime`**.
|
||||||
- Others use **both AgentScope and AgentScope Runtime** to implement **full-stack deployable applications** with frontend + backend.
|
|
||||||
- Full-stack runtime versions have folder names ending with:
|
|
||||||
**`_fullstack_runtime`**
|
|
||||||
|
|
||||||
> 📌 **Before running** any example, check its `README.md` for installation and execution instructions.
|
|
||||||
|
|
||||||
### Install Requirements
|
|
||||||
|
|
||||||
- [AgentScope Documentation](https://doc.agentscope.io/)
|
|
||||||
- [AgentScope Runtime Documentation](https://runtime.agentscope.io/)
|
|
||||||
|
|
||||||
------
|
|
||||||
|
|
||||||
## 🌳 Repository Structure
|
## 🌳 Repository Structure
|
||||||
|
|
||||||
@@ -86,8 +71,6 @@ It includes **agent deployment** and **secure sandboxed tool execution**, and ca
|
|||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
------
|
|
||||||
|
|
||||||
## 📌 Example List
|
## 📌 Example List
|
||||||
|
|
||||||
| Category | Example Folder | Uses AgentScope | Use AgentScope Runtime | Description |
|
| Category | Example Folder | Uses AgentScope | Use AgentScope Runtime | Description |
|
||||||
@@ -107,11 +90,9 @@ It includes **agent deployment** and **secure sandboxed tool execution**, and ca
|
|||||||
| **General AI Agent** | alias/ | ✅ | ✅ | Agent application running in sandbox to solve diverse real-world problems |
|
| **General AI Agent** | alias/ | ✅ | ✅ | Agent application running in sandbox to solve diverse real-world problems |
|
||||||
| **Financial Trading** | evotraders/ | ✅ | ❌ | Self-Evolving Multi-Agent Trading System |
|
| **Financial Trading** | evotraders/ | ✅ | ❌ | Self-Evolving Multi-Agent Trading System |
|
||||||
|
|
||||||
------
|
## 🌈 Featured Examples
|
||||||
|
|
||||||
## 🌟 Featured Examples
|
### 📊 DataJuicer Agent
|
||||||
|
|
||||||
### DataJuicer Agent
|
|
||||||
|
|
||||||
A powerful multi-agent data processing system that leverages Data-Juicer's 200+ operators for intelligent data processing:
|
A powerful multi-agent data processing system that leverages Data-Juicer's 200+ operators for intelligent data processing:
|
||||||
|
|
||||||
@@ -123,8 +104,7 @@ A powerful multi-agent data processing system that leverages Data-Juicer's 200+
|
|||||||
|
|
||||||
📖 **Documentation**: [English](data_juicer_agent/README.md) | [中文](data_juicer_agent/README_ZH.md)
|
📖 **Documentation**: [English](data_juicer_agent/README.md) | [中文](data_juicer_agent/README_ZH.md)
|
||||||
|
|
||||||
|
### 🕵🏻 Alias-Agent
|
||||||
### Alias-Agent
|
|
||||||
|
|
||||||
*Alias-Agent* (short for *Alias*) is designed to serve as an intelligent assistant for tackle diverse and complicated real-world tasks, providing three operational modes for flexible task execution:
|
*Alias-Agent* (short for *Alias*) is designed to serve as an intelligent assistant for tackle diverse and complicated real-world tasks, providing three operational modes for flexible task execution:
|
||||||
- **Simple React**: Employs vanilla reasoning-acting loops to iteratively solve problems and execute tool calls.
|
- **Simple React**: Employs vanilla reasoning-acting loops to iteratively solve problems and execute tool calls.
|
||||||
@@ -135,7 +115,7 @@ Beyond being a ready-to-use agent, we envision Alias as a foundational template
|
|||||||
|
|
||||||
📖 **Documentation**: [English](alias/README.md) | [中文](alias/README_ZH.md)
|
📖 **Documentation**: [English](alias/README.md) | [中文](alias/README_ZH.md)
|
||||||
|
|
||||||
### EvoTraders
|
### 📈 EvoTraders
|
||||||
|
|
||||||
*EvoTraders* is a financial trading agent framework that builds a trading system capable of continuous learning and evolution in real markets through multi-agent collaboration and memory systems. Key features include:
|
*EvoTraders* is a financial trading agent framework that builds a trading system capable of continuous learning and evolution in real markets through multi-agent collaboration and memory systems. Key features include:
|
||||||
|
|
||||||
@@ -146,9 +126,7 @@ Beyond being a ready-to-use agent, we envision Alias as a foundational template
|
|||||||
|
|
||||||
📖 **Documentation**: [English](evotraders/README.md) | [中文](evotraders/README_zh.md)
|
📖 **Documentation**: [English](evotraders/README.md) | [中文](evotraders/README_zh.md)
|
||||||
|
|
||||||
------
|
## 🆘 Getting Help
|
||||||
|
|
||||||
## ℹ️ Getting Help
|
|
||||||
|
|
||||||
If you:
|
If you:
|
||||||
|
|
||||||
@@ -166,8 +144,6 @@ Please:
|
|||||||
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
|
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| <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/i1/O1CN01LxzZha1thpIN2cc2E_!!6000000005934-2-tps-497-477.png" width="100" height="100"> |
|
| <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/i1/O1CN01LxzZha1thpIN2cc2E_!!6000000005934-2-tps-497-477.png" width="100" height="100"> |
|
||||||
|
|
||||||
------
|
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
We welcome contributions such as:
|
We welcome contributions such as:
|
||||||
@@ -177,26 +153,18 @@ We welcome contributions such as:
|
|||||||
- Documentation improvements
|
- Documentation improvements
|
||||||
- Code contributions
|
- Code contributions
|
||||||
|
|
||||||
See the [Contributing](https://github.com/agentscope-ai/agentscope-samples/blob/main/CONTRIBUTING.md) for details.
|
See the [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
||||||
|
|
||||||
------
|
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|
||||||
This project is licensed under the **Apache 2.0 License** – see the [LICENSE](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) file for details.
|
This project is licensed under the **Apache 2.0 License** – see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
|
|
||||||
------
|
|
||||||
|
|
||||||
## 🔗 Resources
|
|
||||||
|
|
||||||
- [AgentScope Documentation](https://doc.agentscope.io/)
|
|
||||||
- [AgentScope Runtime Documentation](https://runtime.agentscope.io/)
|
|
||||||
- [AgentScope GitHub Repository](https://github.com/agentscope-ai/agentscope)
|
|
||||||
- [AgentScope Runtime GitHub Repository](https://github.com/agentscope-ai/agentscope-runtime)
|
|
||||||
|
|
||||||
## Contributors ✨
|
## Contributors ✨
|
||||||
|
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||||
|
[](#contributors-)
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||||
|
|
||||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/emoji-key/)):
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/emoji-key/)):
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||||
|
|||||||
88
README_zh.md
88
README_zh.md
@@ -1,60 +1,45 @@
|
|||||||
# AgentScope 示例 Agent
|
# AgentScope 示例
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
||||||
[](#contributors-)
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
||||||
[](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE)
|
[](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE)
|
||||||
[](https://www.python.org/)
|
[](https://www.python.org/)
|
||||||
|
[](https://deepwiki.com/agentscope-ai/agentscope-samples)
|
||||||
[](https://doc.agentscope.io/)
|
[](https://doc.agentscope.io/)
|
||||||
[](https://runtime.agentscope.io/)
|
[](https://runtime.agentscope.io/)
|
||||||
[](https://github.com/agentscope-ai/agentscope-samples)
|
[](https://github.com/agentscope-ai/agentscope-samples)
|
||||||
|
|
||||||
[[README]](README.md)
|
[[README]](README.md)
|
||||||
|
|
||||||
欢迎来到 **AgentScope 示例 Agent** 仓库!🎯
|
🎯 **快启动你的智能体之旅!**
|
||||||
该仓库提供**可直接使用的 Python 示例 Agent**,它们构建于以下项目之上:
|
这是一个集合了 **各种可直接运行的 Python 智能体示例** 的仓库,涵盖从命令行小工具到 **全栈可部署应用**。
|
||||||
|
|
||||||
- [AgentScope](https://github.com/agentscope-ai/agentscope)
|
## 🌟 什么是 AgentScope?
|
||||||
- [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime)
|
|
||||||
|
|
||||||
这些示例涵盖了广泛的使用场景 —— 从轻量级命令行 Agent,到同时具备前端和后端的**可部署全栈应用**。
|
**[AgentScope](https://github.com/agentscope-ai/agentscope)** 是一个 **多智能体(Multi-Agent)框架**,让你能快速构建 **基于 LLM 的智能应用**:
|
||||||
|
|
||||||
---
|
> 详情请参考:[AgentScope 文档](https://doc.agentscope.io/)
|
||||||
|
- 🧠 定义智能体、集成工具
|
||||||
|
- 📡 管理上下文与对话
|
||||||
|
- 🤝 编排多个智能体协作完成任务
|
||||||
|
|
||||||
## 📖 关于 AgentScope & AgentScope Runtime
|
|
||||||
|
|
||||||
### **AgentScope**
|
|
||||||
|
|
||||||
AgentScope 是一个多 Agent 框架,旨在以**简单高效**的方式构建**基于 LLM 的 Agent 应用**。它提供了用于定义 Agent、集成工具、管理对话以及编排多 Agent 工作流的抽象能力。
|
**[AgentScope-Runtime](https://github.com/agentscope-ai/agentscope-runtime)** 则是智能体运行时框架,让你能将智能体部署成API服务:
|
||||||
|
|
||||||
### **AgentScope Runtime**
|
> 详情请参考:[AgentScope Runtime 文档](https://runtime.agentscope.io/)
|
||||||
|
1. 🔄 **多智能体的可伸缩部署管理**
|
||||||
|
2. 🛡️ **安全工具沙箱执行**
|
||||||
|
|
||||||
AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和运行 Agent 的两个关键问题:
|
结合两者,你可以从原型 **一键走向生产部署**。
|
||||||
|
|
||||||
1. **高效的 Agent 部署** —— 支持跨环境的可扩展部署和管理。
|
## ⚡ 快速开始
|
||||||
2. **沙盒化工具执行** —— 安全、隔离地运行工具和外部操作。
|
|
||||||
|
|
||||||
它包括**Agent 部署**以及**安全的沙盒化工具执行**能力,可搭配 **AgentScope** 或其他 Agent 框架使用。
|
📌 **运行示例之前**,请查看对应的 `README.md` 获取安装与运行说明。
|
||||||
|
|
||||||
---
|
> - 所有示例均基于 **Python**
|
||||||
|
> - 示例按功能、使用场景组织
|
||||||
## ✨ 快速开始
|
> - 有些示例仅使用 **AgentScope**
|
||||||
|
> - 有些示例同时使用 **AgentScope 和 AgentScope Runtime** 来实现**带前端+后端的可部署全栈应用**。
|
||||||
- 所有示例均基于 **Python**。
|
> - 全栈运行时版本的文件夹名称以:**`_fullstack_runtime`** 结尾
|
||||||
- 示例按功能使用场景组织。
|
|
||||||
- 有些示例仅使用 **AgentScope**(纯 Python Agent)。
|
|
||||||
- 有些示例同时使用 **AgentScope 和 AgentScope Runtime** 来实现**带前端+后端的可部署全栈应用**。
|
|
||||||
- 全栈运行时版本的文件夹名称以:
|
|
||||||
**`_fullstack_runtime`** 结尾
|
|
||||||
|
|
||||||
> 📌 **运行示例之前**,请查看对应的 `README.md` 获取安装与运行说明。
|
|
||||||
|
|
||||||
### 安装依赖
|
|
||||||
|
|
||||||
- [AgentScope 文档](https://doc.agentscope.io/)
|
|
||||||
- [AgentScope Runtime 文档](https://runtime.agentscope.io/)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🌳 仓库结构
|
## 🌳 仓库结构
|
||||||
|
|
||||||
@@ -109,9 +94,9 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🌟 特色示例
|
## 🌈 特色示例
|
||||||
|
|
||||||
### DataJuicer 智能体
|
### 📊 DataJuicer 智能体
|
||||||
|
|
||||||
一个强大的数据处理多智能体系统,利用 Data-Juicer 的 200+ 算子进行智能数据处理:
|
一个强大的数据处理多智能体系统,利用 Data-Juicer 的 200+ 算子进行智能数据处理:
|
||||||
|
|
||||||
@@ -123,7 +108,7 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
|
|||||||
|
|
||||||
📖 **文档**:[English](data_juicer_agent/README.md) | [中文](data_juicer_agent/README_ZH.md)
|
📖 **文档**:[English](data_juicer_agent/README.md) | [中文](data_juicer_agent/README_ZH.md)
|
||||||
|
|
||||||
### Alias 智能体
|
### 🕵🏻 Alias 智能体
|
||||||
|
|
||||||
*Alias-Agent*(简称 *Alias*)旨在作为一个智能助手来处理多样且复杂的真实世界任务,提供三种操作模式以实现灵活的任务执行:
|
*Alias-Agent*(简称 *Alias*)旨在作为一个智能助手来处理多样且复杂的真实世界任务,提供三种操作模式以实现灵活的任务执行:
|
||||||
- **Simple React**:采用经典的推理-行动循环来迭代解决问题并执行工具调用。
|
- **Simple React**:采用经典的推理-行动循环来迭代解决问题并执行工具调用。
|
||||||
@@ -134,7 +119,7 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
|
|||||||
|
|
||||||
📖 **文档**:[English](alias/README.md) | [中文](alias/README_ZH.md)
|
📖 **文档**:[English](alias/README.md) | [中文](alias/README_ZH.md)
|
||||||
|
|
||||||
### EvoTraders
|
### 📈 EvoTraders
|
||||||
|
|
||||||
*EvoTraders* 是一个开源的金融交易智能体框架,通过多智能体协作和记忆系统,构建能够在真实市场中持续学习与进化的交易系统。主要特性包括:
|
*EvoTraders* 是一个开源的金融交易智能体框架,通过多智能体协作和记忆系统,构建能够在真实市场中持续学习与进化的交易系统。主要特性包括:
|
||||||
|
|
||||||
@@ -147,7 +132,7 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ℹ️ 获取帮助
|
## 🆘 获取帮助
|
||||||
|
|
||||||
如果你:
|
如果你:
|
||||||
|
|
||||||
@@ -176,25 +161,18 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
|
|||||||
- 文档改进
|
- 文档改进
|
||||||
- 代码贡献
|
- 代码贡献
|
||||||
|
|
||||||
详情见 [Contributing](https://github.com/agentscope-ai/agentscope-samples/blob/main/CONTRIBUTING_zh.md) 文档。
|
详情见 [CONTRIBUTING_zh.md](CONTRIBUTING_zh.md) 文档。
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📄 许可证
|
## 📄 许可证
|
||||||
|
|
||||||
本项目基于 **Apache 2.0 License** 授权,详见 [LICENSE](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) 文件。
|
本项目基于 **Apache 2.0 License** 授权,详见 [LICENSE](LICENSE) 文件。
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🔗 相关资源
|
|
||||||
|
|
||||||
- [AgentScope 文档](https://doc.agentscope.io/)
|
|
||||||
- [AgentScope Runtime 文档](https://runtime.agentscope.io/)
|
|
||||||
- [AgentScope GitHub 仓库](https://github.com/agentscope-ai/agentscope)
|
|
||||||
- [AgentScope Runtime GitHub 仓库](https://github.com/agentscope-ai/agentscope-runtime)
|
|
||||||
|
|
||||||
## 贡献者 ✨
|
## 贡献者 ✨
|
||||||
|
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||||
|
[](#contributors-)
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||||
|
|
||||||
感谢这些优秀的贡献者们 ([表情符号说明](https://allcontributors.org/emoji-key/)):
|
感谢这些优秀的贡献者们 ([表情符号说明](https://allcontributors.org/emoji-key/)):
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||||
|
|||||||
Reference in New Issue
Block a user