diff --git a/README.md b/README.md index 88b819a..de84037 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,13 @@

-[Community](https://github.com/camel-ai/camel#community) | -[Installation](https://github.com/camel-ai/camel#installation) | -[Examples](https://github.com/camel-ai/camel/tree/HEAD/examples) | +[中文阅读](https://github.com/camel-ai/owl/tree/main/README_zh.md) | +[Community](https://github.com/camel-ai/owl#community) | +[Installation](#️-installation) | +[Examples](https://github.com/camel-ai/owl/tree/main/owl) | [Paper](https://arxiv.org/abs/2303.17760) | -[Citation](https://github.com/camel-ai/camel#citation) | -[Contributing](https://github.com/camel-ai/camel#contributing-to-camel-) | +[Citation](#-community) | +[Contributing](https://github.com/camel-ai/owl/graphs/contributors) | [CAMEL-AI](https://www.camel-ai.org/)

@@ -169,9 +170,9 @@ Join us for further discussions! [docs-image]: https://img.shields.io/badge/Documentation-EB3ECC [docs-url]: https://camel-ai.github.io/camel/index.html [star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen -[star-url]: https://github.com/camel-ai/camel/stargazers +[star-url]: https://github.com/camel-ai/owl/stargazers [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg -[package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE +[package-license-url]: https://github.com/camel-ai/owl/blob/main/licenses/LICENSE [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing [colab-image]: https://colab.research.google.com/assets/colab-badge.svg diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..db0458e --- /dev/null +++ b/README_zh.md @@ -0,0 +1,193 @@ +

+ 🦉 OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation + 🦉 OWL: 优化劳动力学习的通用智能体,用于处理现实世界的自动化任务 +

+ + +
+ +[![文档][docs-image]][docs-url] +[![Discord][discord-image]][discord-url] +[![X][x-image]][x-url] +[![Reddit][reddit-image]][reddit-url] +[![微信][wechat-image]][wechat-url] +[![微信][owl-image]][owl-url] +[![Hugging Face][huggingface-image]][huggingface-url] +[![Star][star-image]][star-url] +[![软件许可证][package-license-image]][package-license-url] + + +
+ + +
+ +
+

+ +[English README](https://github.com/camel-ai/owl/tree/main) | +[社区](https://github.com/camel-ai/camel#community) | +[安装](#️-installation) | +[示例](https://github.com/camel-ai/owl/tree/main/owl) | +[论文](https://arxiv.org/abs/2303.17760) | +[引用](#-community) | +[贡献](https://github.com/camel-ai/owl/graphs/contributors) | +[CAMEL-AI](https://www.camel-ai.org/) + +

+ +
+ +🦉 OWL 是一个前沿的多智能体协作框架,推动任务自动化的边界,构建在 [CAMEL-AI Framework](https://github.com/camel-ai/camel)。 + +OWL 在 GAIA 基准测试中取得 **58.18** 平均分,在开源框架中排名 🏅️ #1。 + +我们的愿景是彻底变革 AI 智能体协作解决现实任务的方式。通过利用动态智能体交互,OWL 实现了跨多领域更自然、高效且稳健的任务自动化。 + +
+ +
+ + +
+ + +# 📋 目录 + +- [📋 目录](#-table-of-contents) +- [🔥 新闻](#-news) +- [🎬 演示视频](#-demo-video) +- [🛠️ 安装](#️-installation) + - [**克隆 Github 仓库**](#clone-the-github-repository) + - [**设置环境**](#set-up-environment) + - [**安装依赖**](#install-dependencies) + - [**设置环境变量**](#setup-environment-variables) +- [🚀 快速开始](#-quick-start) +- [🧪 实验](#-experiments) +- [⏱️ 未来计划](#️-future-plans) +- [📄 许可证](#-license) +- [🖊️ 引用](#️-cite) +- [🔥 社区](#-community) + + +# 🔥 新闻 + +- **[2025.03.07]**: 我们开源了 🦉 OWL 项目的代码库。 + +# 🎬 演示视频 + +https://private-user-images.githubusercontent.com/55657767/420211368-f29f477d-7eef-46da-8d7a-8f3bcf506da2.mp4 + +https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-136a-485f-8df3-f10d9b4e63ec.mp4 + +# 🛠️ 安装 + +## **克隆 Github 仓库** + +```bash +git clone https://github.com/camel-ai/owl.git +cd owl +``` + +## **设置环境** + +使用 Conda(推荐): +```bash +conda create -n owl python=3.11 +conda activate owl +``` + +使用 venv(备用): +```bash +python -m venv owl_env +# Windows 系统 +owl_env\Scripts\activate +# Unix 或 MacOS 系统 +source owl_env/bin/activate +``` + +## **安装依赖** + +```bash +python -m pip install -r requirements.txt +``` + +## **设置环境变量** + +在 `owl/.env_example` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作: + +1. *复制并重命名*: 复制 `.env_example` 文件,并将副本重命名为 `.env`。 +2. *填写你的密钥*: 打开 `.env` 文件,在相应字段中填入你的 API 密钥。 + +# 🚀 快速开始 + +运行以下最小示例: + +```bash +python owl/run.py +``` + +# 🧪 实验 + +我们提供了一个脚本用于复现 GAIA 上的实验结果。 +你可以查看 `run_gaia_roleplaying.py` 文件,并运行以下命令: + +```bash +python run_gaia_roleplaying.py +``` + +# ⏱️ 未来计划 + +- [ ] 撰写一篇技术博客,详细介绍我们在现实任务中多智能体协作方面的探索与见解。 +- [ ] 通过引入更多针对特定领域任务的专业工具,进一步完善工具生态系统。 +- [ ] 开发更复杂的智能体交互模式和通信协议 + + +# 📄 许可证 + +源代码采用 Apache 2.0 许可证。 + +# 🖊️ 引用 + +如果你觉得这个仓库对你有帮助,请引用: + + +``` +@misc{owl2025, + title = {OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation}, + author = {{CAMEL-AI.org}}, + howpublished = {\url{https://github.com/camel-ai/owl}}, + note = {Accessed: 2025-03-07}, + year = {2025} +} +``` + +# 🔥 社区 +加入我们,参与更多讨论! +![](./assets/community.png) + + + +[docs-image]: https://img.shields.io/badge/Documentation-EB3ECC +[docs-url]: https://camel-ai.github.io/camel/index.html +[star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen +[star-url]: https://github.com/camel-ai/owl/stargazers +[package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg +[package-license-url]: https://github.com/camel-ai/owl/blob/main/licenses/LICENSE + +[colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing +[colab-image]: https://colab.research.google.com/assets/colab-badge.svg +[huggingface-url]: https://huggingface.co/camel-ai +[huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white +[discord-url]: https://discord.camel-ai.org/ +[discord-image]: https://img.shields.io/discord/1082486657678311454?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb +[wechat-url]: https://ghli.org/camel/wechat.png +[wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white +[x-url]: https://x.com/CamelAIOrg +[x-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social +[twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter +[reddit-url]: https://www.reddit.com/r/CamelAI/ +[reddit-image]: https://img.shields.io/reddit/subreddit-subscribers/CamelAI?style=plastic&logo=reddit&label=r%2FCAMEL&labelColor=white +[ambassador-url]: https://www.camel-ai.org/community +[owl-url]: ./assets/qr_code.jpg +[owl-image]: https://img.shields.io/badge/WeChat-OWLProject-brightgreen?logo=wechat&logoColor=white diff --git a/licenses/LICENSE b/licenses/LICENSE new file mode 100644 index 0000000..0f91e59 --- /dev/null +++ b/licenses/LICENSE @@ -0,0 +1,13 @@ +# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. ========= +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========