From 534a64038751b212e324696604317bb3e4e1027b Mon Sep 17 00:00:00 2001 From: Weirui Kuang <39145382+rayrayraykk@users.noreply.github.com> Date: Thu, 11 Dec 2025 20:45:19 +0800 Subject: [PATCH] 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> --- README.md | 96 ++++++++++++++++++---------------------------------- README_zh.md | 88 ++++++++++++++++++----------------------------- 2 files changed, 65 insertions(+), 119 deletions(-) diff --git a/README.md b/README.md index 073fd08..5f4cb1d 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,45 @@ -# AgentScope Sample Agents +# AgentScope Samples - -[![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat-square)](#contributors-) - [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) [![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://www.python.org/) +[![DeepWiki](https://img.shields.io/badge/DeepWiki-agentscope--samples-navy.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/agentscope-ai/agentscope-samples) [![Docs](https://img.shields.io/badge/docs-AgentScope-blue)](https://doc.agentscope.io/) [![Runtime Docs](https://img.shields.io/badge/docs-AgentScope%20Runtime-red)](https://runtime.agentscope.io/) [![Last Commit](https://img.shields.io/github/last-commit/agentscope-ai/agentscope-samples)](https://github.com/agentscope-ai/agentscope-samples) [[中文README]](README_zh.md) -Welcome to the **AgentScope Sample Agents** repository! 🎯 -This repository provides **ready-to-use Python sample agents** built on top of: +🎯 **Kickstart Your Agent Journey!** +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) -- [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime) +## 🌟 What is AgentScope? -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. -2. **Sandboxed Tool Execution** – Secure, isolated execution of tools and external actions. +1. 🔄 **Scalable deployment management for multiple agents** +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 samples are **Python-based**. -- Samples are organized **by functional use case**. -- Some samples use only **AgentScope** (pure Python agents). -- 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/) - ------- +> - All examples are built with **Python**. +> - Examples are organized by **functionality** and **usage scenario**. +> - Some examples use **AgentScope** only. +> - Some examples use **both AgentScope and AgentScope Runtime** to implement **deployable full-stack applications with frontend + backend**. +> - Full-stack runtime versions have folder names ending with **`_fullstack_runtime`**. ## 🌳 Repository Structure @@ -86,8 +71,6 @@ It includes **agent deployment** and **secure sandboxed tool execution**, and ca └── README.md ``` ------- - ## 📌 Example List | 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 | | **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: @@ -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) - -### 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: - **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) -### 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: @@ -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) ------- - -## ℹ️ Getting Help +## 🆘 Getting Help If you: @@ -166,8 +144,6 @@ Please: |----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| | | | ------- - ## 🤝 Contributing We welcome contributions such as: @@ -177,26 +153,18 @@ We welcome contributions such as: - Documentation improvements - 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 -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. - - ------- - -## 🔗 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) +This project is licensed under the **Apache 2.0 License** – see the [LICENSE](LICENSE) file for details. ## Contributors ✨ + +[![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat-square)](#contributors-) + + Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/emoji-key/)): diff --git a/README_zh.md b/README_zh.md index 45bc7d1..7142290 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,60 +1,45 @@ -# AgentScope 示例 Agent +# AgentScope 示例 - -[![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat-square)](#contributors-) - [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) [![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://www.python.org/) +[![DeepWiki](https://img.shields.io/badge/DeepWiki-agentscope--samples-navy.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/agentscope-ai/agentscope-samples) [![Docs](https://img.shields.io/badge/docs-AgentScope-blue)](https://doc.agentscope.io/) [![Runtime Docs](https://img.shields.io/badge/docs-AgentScope%20Runtime-red)](https://runtime.agentscope.io/) [![Last Commit](https://img.shields.io/github/last-commit/agentscope-ai/agentscope-samples)](https://github.com/agentscope-ai/agentscope-samples) [[README]](README.md) -欢迎来到 **AgentScope 示例 Agent** 仓库！🎯 -该仓库提供**可直接使用的 Python 示例 Agent**，它们构建于以下项目之上： +🎯 **快启动你的智能体之旅！** +这是一个集合了 **各种可直接运行的 Python 智能体示例** 的仓库，涵盖从命令行小工具到 **全栈可部署应用**。 -- [AgentScope](https://github.com/agentscope-ai/agentscope) -- [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime) +## 🌟 什么是 AgentScope？ -这些示例涵盖了广泛的使用场景 —— 从轻量级命令行 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**（纯 Python Agent）。 -- 有些示例同时使用 **AgentScope 和 AgentScope Runtime** 来实现**带前端+后端的可部署全栈应用**。 -- 全栈运行时版本的文件夹名称以： - **`_fullstack_runtime`** 结尾 - -> 📌 **运行示例之前**，请查看对应的 `README.md` 获取安装与运行说明。 - -### 安装依赖 - -- [AgentScope 文档](https://doc.agentscope.io/) -- [AgentScope Runtime 文档](https://runtime.agentscope.io/) - ---- +> - 所有示例均基于 **Python** +> - 示例按功能、使用场景组织 +> - 有些示例仅使用 **AgentScope** +> - 有些示例同时使用 **AgentScope 和 AgentScope Runtime** 来实现**带前端+后端的可部署全栈应用**。 +> - 全栈运行时版本的文件夹名称以：**`_fullstack_runtime`** 结尾 ## 🌳 仓库结构 @@ -109,9 +94,9 @@ AgentScope Runtime 是一个**全面的运行时框架**，主要解决部署和 --- -## 🌟 特色示例 +## 🌈 特色示例 -### DataJuicer 智能体 +### 📊 DataJuicer 智能体 一个强大的数据处理多智能体系统，利用 Data-Juicer 的 200+ 算子进行智能数据处理： @@ -123,7 +108,7 @@ AgentScope Runtime 是一个**全面的运行时框架**，主要解决部署和 📖 **文档**：[English](data_juicer_agent/README.md) | [中文](data_juicer_agent/README_ZH.md) -### Alias 智能体 +### 🕵🏻 Alias 智能体 *Alias-Agent*（简称 *Alias*）旨在作为一个智能助手来处理多样且复杂的真实世界任务，提供三种操作模式以实现灵活的任务执行： - **Simple React**：采用经典的推理-行动循环来迭代解决问题并执行工具调用。 @@ -134,7 +119,7 @@ AgentScope Runtime 是一个**全面的运行时框架**，主要解决部署和 📖 **文档**：[English](alias/README.md) | [中文](alias/README_ZH.md) -### 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) 文件。 - ---- - -## 🔗 相关资源 - -- [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) +本项目基于 **Apache 2.0 License** 授权，详见 [LICENSE](LICENSE) 文件。 ## 贡献者 ✨ + +[![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat-square)](#contributors-) + + 感谢这些优秀的贡献者们 ([表情符号说明](https://allcontributors.org/emoji-key/)):