勤劳上班的卑微小张 commited on
Commit
9e0dba2
·
1 Parent(s): f9fa66a

feat: add README_zh.md And LICENSE

Browse files
Files changed (3) hide show
  1. README.md +8 -7
  2. README_zh.md +193 -0
  3. licenses/LICENSE +13 -0
README.md CHANGED
@@ -24,12 +24,13 @@
24
  <div align="center">
25
  <h4 align="center">
26
 
27
- [Community](https://github.com/camel-ai/camel#community) |
28
- [Installation](https://github.com/camel-ai/camel#installation) |
29
- [Examples](https://github.com/camel-ai/camel/tree/HEAD/examples) |
 
30
  [Paper](https://arxiv.org/abs/2303.17760) |
31
- [Citation](https://github.com/camel-ai/camel#citation) |
32
- [Contributing](https://github.com/camel-ai/camel#contributing-to-camel-) |
33
  [CAMEL-AI](https://www.camel-ai.org/)
34
 
35
  </h4>
@@ -169,9 +170,9 @@ Join us for further discussions!
169
  [docs-image]: https://img.shields.io/badge/Documentation-EB3ECC
170
  [docs-url]: https://camel-ai.github.io/camel/index.html
171
  [star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen
172
- [star-url]: https://github.com/camel-ai/camel/stargazers
173
  [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
174
- [package-license-url]: https://github.com/camel-ai/camel/blob/master/licenses/LICENSE
175
 
176
  [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
177
  [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
 
24
  <div align="center">
25
  <h4 align="center">
26
 
27
+ [中文阅读](https://github.com/camel-ai/owl/tree/main/README_zh.md) |
28
+ [Community](https://github.com/camel-ai/owl#community) |
29
+ [Installation](#️-installation) |
30
+ [Examples](https://github.com/camel-ai/owl/tree/main/owl) |
31
  [Paper](https://arxiv.org/abs/2303.17760) |
32
+ [Citation](#-community) |
33
+ [Contributing](https://github.com/camel-ai/owl/graphs/contributors) |
34
  [CAMEL-AI](https://www.camel-ai.org/)
35
 
36
  </h4>
 
170
  [docs-image]: https://img.shields.io/badge/Documentation-EB3ECC
171
  [docs-url]: https://camel-ai.github.io/camel/index.html
172
  [star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen
173
+ [star-url]: https://github.com/camel-ai/owl/stargazers
174
  [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
175
+ [package-license-url]: https://github.com/camel-ai/owl/blob/main/licenses/LICENSE
176
 
177
  [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
178
  [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
README_zh.md ADDED
@@ -0,0 +1,193 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <h1 align="center">
2
+ 🦉 OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation
3
+ 🦉 OWL: 优化劳动力学习的通用智能体,用于处理现实世界的自动化任务
4
+ </h1>
5
+
6
+
7
+ <div align="center">
8
+
9
+ [![文档][docs-image]][docs-url]
10
+ [![Discord][discord-image]][discord-url]
11
+ [![X][x-image]][x-url]
12
+ [![Reddit][reddit-image]][reddit-url]
13
+ [![微信][wechat-image]][wechat-url]
14
+ [![微信][owl-image]][owl-url]
15
+ [![Hugging Face][huggingface-image]][huggingface-url]
16
+ [![Star][star-image]][star-url]
17
+ [![软件许可证][package-license-image]][package-license-url]
18
+
19
+
20
+ </div>
21
+
22
+
23
+ <hr>
24
+
25
+ <div align="center">
26
+ <h4 align="center">
27
+
28
+ [English README](https://github.com/camel-ai/owl/tree/main) |
29
+ [社区](https://github.com/camel-ai/camel#community) |
30
+ [安装](#️-installation) |
31
+ [示例](https://github.com/camel-ai/owl/tree/main/owl) |
32
+ [论文](https://arxiv.org/abs/2303.17760) |
33
+ [引用](#-community) |
34
+ [贡献](https://github.com/camel-ai/owl/graphs/contributors) |
35
+ [CAMEL-AI](https://www.camel-ai.org/)
36
+
37
+ </h4>
38
+
39
+ <div align="center">
40
+
41
+ 🦉 OWL 是一个前沿的多智能体协作框架,推动任务自动化的边界,构建在 [CAMEL-AI Framework](https://github.com/camel-ai/camel)。
42
+
43
+ OWL 在 GAIA 基准测试中取得 **58.18** 平均分,在开源框架中排名 🏅️ #1。
44
+
45
+ 我们的愿景是彻底变革 AI 智能体协作解决现实任务的方式。通过利用动态智能体交互,OWL 实现了跨多领域更自然、高效且稳健的任务自动化。
46
+
47
+ </div>
48
+
49
+ <br>
50
+
51
+
52
+ </div>
53
+
54
+ <!-- # Key Features -->
55
+ # 📋 目录
56
+
57
+ - [📋 目录](#-table-of-contents)
58
+ - [🔥 新闻](#-news)
59
+ - [🎬 演示视频](#-demo-video)
60
+ - [🛠️ 安装](#️-installation)
61
+ - [**克隆 Github 仓库**](#clone-the-github-repository)
62
+ - [**设置环境**](#set-up-environment)
63
+ - [**安装依赖**](#install-dependencies)
64
+ - [**设置环境变量**](#setup-environment-variables)
65
+ - [🚀 快速开始](#-quick-start)
66
+ - [🧪 实验](#-experiments)
67
+ - [⏱️ 未来计划](#️-future-plans)
68
+ - [📄 许可证](#-license)
69
+ - [🖊️ 引用](#️-cite)
70
+ - [🔥 社区](#-community)
71
+
72
+
73
+ # 🔥 新闻
74
+
75
+ - **[2025.03.07]**: 我们开源了 🦉 OWL 项目的代码库。
76
+
77
+ # 🎬 演示视频
78
+
79
+ https://private-user-images.githubusercontent.com/55657767/420211368-f29f477d-7eef-46da-8d7a-8f3bcf506da2.mp4
80
+
81
+ https://private-user-images.githubusercontent.com/55657767/420212194-e813fc05-136a-485f-8df3-f10d9b4e63ec.mp4
82
+
83
+ # 🛠️ 安装
84
+
85
+ ## **克隆 Github 仓库**
86
+
87
+ ```bash
88
+ git clone https://github.com/camel-ai/owl.git
89
+ cd owl
90
+ ```
91
+
92
+ ## **设置环境**
93
+
94
+ 使用 Conda(推荐):
95
+ ```bash
96
+ conda create -n owl python=3.11
97
+ conda activate owl
98
+ ```
99
+
100
+ 使用 venv(备用):
101
+ ```bash
102
+ python -m venv owl_env
103
+ # Windows 系统
104
+ owl_env\Scripts\activate
105
+ # Unix 或 MacOS 系统
106
+ source owl_env/bin/activate
107
+ ```
108
+
109
+ ## **安装依赖**
110
+
111
+ ```bash
112
+ python -m pip install -r requirements.txt
113
+ ```
114
+
115
+ ## **设置环境变量**
116
+
117
+ 在 `owl/.env_example` 文件中,你可以找到所有必要的 API 密钥以及各服务的注册网址。要使用这些 API 服务,请按照以下步骤操作:
118
+
119
+ 1. *复制并重命名*: 复制 `.env_example` 文件,并将副本重命名为 `.env`。
120
+ 2. *填写你的密钥*: 打开 `.env` 文件,在相应字段中填入你的 API 密钥。
121
+
122
+ # 🚀 快速开始
123
+
124
+ 运行以下最小示例:
125
+
126
+ ```bash
127
+ python owl/run.py
128
+ ```
129
+
130
+ # 🧪 实验
131
+
132
+ 我们提供了一个脚本用于复现 GAIA 上的实验结果。
133
+ 你可以查看 `run_gaia_roleplaying.py` 文件,并运行以下命令:
134
+
135
+ ```bash
136
+ python run_gaia_roleplaying.py
137
+ ```
138
+
139
+ # ⏱️ 未来计划
140
+
141
+ - [ ] 撰写一篇技术博客,详细介绍我们在现实任务中多智能体协作方面的探索与见解。
142
+ - [ ] 通过引入更多针对特定领域任务的专业工具,进一步完善工具生态系统。
143
+ - [ ] 开发更复杂的智能体交互模式和通信协议
144
+
145
+
146
+ # 📄 许可证
147
+
148
+ 源代码采用 Apache 2.0 许可证。
149
+
150
+ # 🖊️ 引用
151
+
152
+ 如果你觉得这个仓库对你有帮助,请引用:
153
+
154
+
155
+ ```
156
+ @misc{owl2025,
157
+ title = {OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation},
158
+ author = {{CAMEL-AI.org}},
159
+ howpublished = {\url{https://github.com/camel-ai/owl}},
160
+ note = {Accessed: 2025-03-07},
161
+ year = {2025}
162
+ }
163
+ ```
164
+
165
+ # 🔥 社区
166
+ 加入我们,参与更多讨论!
167
+ ![](./assets/community.png)
168
+
169
+
170
+
171
+ [docs-image]: https://img.shields.io/badge/Documentation-EB3ECC
172
+ [docs-url]: https://camel-ai.github.io/camel/index.html
173
+ [star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen
174
+ [star-url]: https://github.com/camel-ai/owl/stargazers
175
+ [package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
176
+ [package-license-url]: https://github.com/camel-ai/owl/blob/main/licenses/LICENSE
177
+
178
+ [colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
179
+ [colab-image]: https://colab.research.google.com/assets/colab-badge.svg
180
+ [huggingface-url]: https://huggingface.co/camel-ai
181
+ [huggingface-image]: https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-CAMEL--AI-ffc107?color=ffc107&logoColor=white
182
+ [discord-url]: https://discord.camel-ai.org/
183
+ [discord-image]: https://img.shields.io/discord/1082486657678311454?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb
184
+ [wechat-url]: https://ghli.org/camel/wechat.png
185
+ [wechat-image]: https://img.shields.io/badge/WeChat-CamelAIOrg-brightgreen?logo=wechat&logoColor=white
186
+ [x-url]: https://x.com/CamelAIOrg
187
+ [x-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social
188
+ [twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter
189
+ [reddit-url]: https://www.reddit.com/r/CamelAI/
190
+ [reddit-image]: https://img.shields.io/reddit/subreddit-subscribers/CamelAI?style=plastic&logo=reddit&label=r%2FCAMEL&labelColor=white
191
+ [ambassador-url]: https://www.camel-ai.org/community
192
+ [owl-url]: ./assets/qr_code.jpg
193
+ [owl-image]: https://img.shields.io/badge/WeChat-OWLProject-brightgreen?logo=wechat&logoColor=white
licenses/LICENSE ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
2
+ # Licensed under the Apache License, Version 2.0 (the "License");
3
+ # you may not use this file except in compliance with the License.
4
+ # You may obtain a copy of the License at
5
+ #
6
+ # http://www.apache.org/licenses/LICENSE-2.0
7
+ #
8
+ # Unless required by applicable law or agreed to in writing, software
9
+ # distributed under the License is distributed on an "AS IS" BASIS,
10
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+ # See the License for the specific language governing permissions and
12
+ # limitations under the License.
13
+ # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========