Skip to content

Commit 5f4e80a

Browse files
committed
minor update
1 parent 338087f commit 5f4e80a

File tree

12 files changed

+258
-236
lines changed

12 files changed

+258
-236
lines changed

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@
1818
[![Star][star-image]][star-url]
1919
[![Package License][package-license-image]][package-license-url]
2020

21-
2221
</div>
2322

24-
2523
<hr>
2624

2725
<div align="center">
@@ -56,10 +54,10 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
5654

5755
<br>
5856

59-
6057
</div>
6158

6259
<!-- # Key Features -->
60+
6361
# 📋 Table of Contents
6462

6563
- [📋 Table of Contents](#-table-of-contents)
@@ -117,7 +115,6 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
117115

118116
# 🔥 News
119117

120-
121118
<div align="center" style="background-color: #e8f5e9; padding: 15px; border-radius: 10px; border: 2px solid #4caf50; margin: 20px 0;">
122119
<h3 style="color: #2e7d32; margin: 0; font-size: 1.3em;">
123120
🧩 <b>NEW: COMMUNITY AGENT CHALLENGES!</b> 🧩
@@ -146,8 +143,8 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
146143
</div> -->
147144

148145
- **[2025.09.22]**: Exicited to announce that OWL has been accepted by NeurIPS 2025!🚀 Check the latest paper [here](https://arxiv.org/abs/2505.23885).
149-
- **[2025.07.21]**: We open-sourced the training dataset and model checkpoints of OWL project. Training code coming soon. [huggingface link](https://huggingface.co/collections/camel-ai/optimized-workforce-learning-682ef4ab498befb9426e6e27).
150-
- **[2025.05.27]**: We released the technical report of OWL, including more details on the workforce (framework) and optimized workforce learning (training methodology). [paper](https://arxiv.org/abs/2505.23885).
146+
- **[2025.07.21]**: We open-sourced the training dataset and model checkpoints of OWL project. Training code coming soon. [huggingface link](https://huggingface.co/collections/camel-ai/optimized-workforce-learning-682ef4ab498befb9426e6e27).
147+
- **[2025.05.27]**: We released the technical report of OWL, including more details on the workforce (framework) and optimized workforce learning (training methodology). [paper](https://arxiv.org/abs/2505.23885).
151148
- **[2025.05.18]**: We open-sourced an initial version for replicating workforce experiment on GAIA [here](https://github.com/camel-ai/owl/tree/gaia69).
152149
- **[2025.04.18]**: We uploaded OWL's new GAIA benchmark score of **69.09%**, ranking #1 among open-source frameworks. Check the technical report [here](https://hypnotic-mind-6bd.notion.site/OWL-Optimized-Workforce-Learning-for-General-Multi-Agent-Assistance-in-Real-World-Task-Automation-1d4004aeb21380158749c7f84b20643f).
153150
- **[2025.03.27]**: Integrate SearxNGToolkit performing web searches using SearxNG search engine.
@@ -162,7 +159,6 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
162159
- **[2025.03.07]**: We open-sourced the codebase of the 🦉 OWL project.
163160
- **[2025.03.03]**: OWL achieved the #1 position among open-source frameworks on the GAIA benchmark with a score of 58.18.
164161

165-
166162
# 🎬 Demo Video
167163

168164
https://github.com/user-attachments/assets/2a2a825d-39ea-45c5-9ba1-f9d58efbc372
@@ -187,6 +183,7 @@ This video demonstrates how to install OWL locally and showcases its capabilitie
187183
## **Prerequisites**
188184

189185
### Install Python
186+
190187
Before installing OWL, ensure you have Python installed (version 3.10, 3.11, or 3.12 is supported):
191188

192189
> **Note for GAIA Benchmark Users**: When running the GAIA benchmark evaluation, please use the `gaia58.18` branch which includes a customized version of the CAMEL framework in the `owl/camel` directory. This version contains enhanced toolkits with improved stability specifically optimized for the GAIA benchmark compared to the standard CAMEL installation.
@@ -334,12 +331,14 @@ OWL requires various API keys to interact with different services.
334331
You can set environment variables directly in your terminal:
335332

336333
- **macOS/Linux (Bash/Zsh)**:
334+
337335
```bash
338336
export OPENAI_API_KEY="your-openai-api-key-here"
339337
# Add other required API keys as needed
340338
```
341339

342340
- **Windows (Command Prompt)**:
341+
343342
```batch
344343
set OPENAI_API_KEY=your-openai-api-key-here
345344
```
@@ -356,11 +355,12 @@ You can set environment variables directly in your terminal:
356355
If you prefer using a `.env` file instead, you can:
357356

358357
1. **Copy and Rename the Template**:
358+
359359
```bash
360360
# For macOS/Linux
361361
cd owl
362362
cp .env_template .env
363-
363+
364364
# For Windows
365365
cd owl
366366
copy .env_template .env
@@ -463,7 +463,6 @@ print(f"\033[94mAnswer: {answer}\033[0m")
463463

464464
OWL will then automatically invoke document-related tools to process the file and extract the answer.
465465

466-
467466
### Example Tasks
468467

469468
Here are some tasks you can try with OWL:
@@ -481,30 +480,37 @@ Here are some tasks you can try with OWL:
481480
OWL's MCP integration provides a standardized way for AI models to interact with various tools and data sources:
482481

483482
Before using MCP, you need to install Node.js first.
483+
484484
### **Install Node.js**
485+
485486
### Windows
486487

487488
Download the official installer: [Node.js](https://nodejs.org/en).
488489

489490
Check "Add to PATH" option during installation.
490491

491492
### Linux
493+
492494
```bash
493495
sudo apt update
494496
sudo apt install nodejs npm -y
495497
```
498+
496499
### Mac
500+
497501
```bash
498502
brew install node
499503
```
500504

501505
### **Install Playwright MCP Service**
506+
502507
```bash
503508
npm install -g @executeautomation/playwright-mcp-server
504509
npx playwright install-deps
505510
```
506511

507512
Try our comprehensive MCP examples:
513+
508514
- `examples/run_mcp.py` - Basic MCP functionality demonstration (local call, requires dependencies)
509515
- `examples/run_mcp_sse.py` - Example using the SSE protocol (Use remote services, no dependencies)
510516

@@ -538,17 +544,19 @@ tools = [
538544
Key toolkits include:
539545

540546
### Multimodal Toolkits (Require multimodal model capabilities)
547+
541548
- **BrowserToolkit**: Browser automation for web interaction and navigation
542549
- **VideoAnalysisToolkit**: Video processing and content analysis
543550
- **ImageAnalysisToolkit**: Image analysis and interpretation
544551

545552
### Text-Based Toolkits
553+
546554
- **AudioAnalysisToolkit**: Audio processing (requires OpenAI API)
547555
- **CodeExecutionToolkit**: Python code execution and evaluation
548556
- **SearchToolkit**: Web searches (Google, DuckDuckGo, Wikipedia)
549557
- **DocumentProcessingToolkit**: Document parsing (PDF, DOCX, etc.)
550558

551-
Additional specialized toolkits: ArxivToolkit, GitHubToolkit, GoogleMapsToolkit, MathToolkit, NetworkXToolkit, NotionToolkit, RedditToolkit, WeatherToolkit, and more. For a complete list, see the [CAMEL toolkits documentation](https://docs.camel-ai.org/key_modules/tools.html#built-in-toolkits).
559+
Additional specialized toolkits: ArxivToolkit, GitHubToolkit, GoogleMapsToolkit, MathToolkit, NetworkXToolkit, NotionToolkit, RedditToolkit, WeatherToolkit, and more. For a complete list, see the [CAMEL toolkits documentation](https://docs.camel-ai.org/key_modules/tools).
552560

553561
## Customizing Your Configuration
554562

@@ -613,6 +621,7 @@ Furthermore, to ensure optimal performance on the GAIA benchmark, please note th
613621
When running the benchmark evaluation:
614622

615623
1. Switch to the `gaia69` branch:
624+
616625
```bash
617626
git checkout gaia69
618627
```
@@ -624,7 +633,6 @@ When running the benchmark evaluation:
624633

625634
This will execute the same configuration that achieved our top-ranking performance on the GAIA benchmark.
626635

627-
628636
# ⏱️ Future Plans
629637

630638
We're continuously working to improve OWL. Here's what's on our roadmap:
@@ -647,6 +655,7 @@ We welcome contributions from the community! Here's how you can help:
647655
3. Submit pull requests with your improvements
648656

649657
**Current Issues Open for Contribution:**
658+
650659
- [#1915](https://github.com/camel-ai/camel/issues/1915)
651660
- [#2190](https://github.com/camel-ai/camel/issues/2190)
652661
- [#2165](https://github.com/camel-ai/camel/issues/2165)
@@ -659,9 +668,10 @@ To take on an issue, simply leave a comment stating your interest.
659668

660669
# 🔥 Community
661670

662-
Join us ([*Discord*](https://discord.camel-ai.org/) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of finding the scaling laws of agents.
671+
Join us ([_Discord_](https://discord.camel-ai.org/) or [_WeChat_](https://ghli.org/camel/wechat.png)) in pushing the boundaries of finding the scaling laws of agents.
663672

664673
Join us for further discussions!
674+
665675
<!-- ![](./assets/community.png) -->
666676
<img src="./assets/community_code.jpeg" width="50%" />
667677

@@ -675,7 +685,7 @@ A: If OWL determines that a task can be completed using non-browser tools (such
675685

676686
**Q: Which Python version should I use?**
677687

678-
A: OWL supports Python 3.10, 3.11, and 3.12.
688+
A: OWL supports Python 3.10, 3.11, and 3.12.
679689

680690
**Q: How can I contribute to the project?**
681691

@@ -709,32 +719,28 @@ cd camel
709719

710720
If you find this repo useful, please cite:
711721

712-
713722
```
714723
@misc{hu2025owl,
715-
title={OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation},
724+
title={OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation},
716725
author={Mengkang Hu and Yuhang Zhou and Wendong Fan and Yuzhou Nie and Bowei Xia and Tao Sun and Ziyu Ye and Zhaoxuan Jin and Yingru Li and Qiguang Chen and Zeyu Zhang and Yifeng Wang and Qianshuo Ye and Bernard Ghanem and Ping Luo and Guohao Li},
717726
year={2025},
718727
eprint={2505.23885},
719728
archivePrefix={arXiv},
720729
primaryClass={cs.AI},
721-
url={https://arxiv.org/abs/2505.23885},
730+
url={https://arxiv.org/abs/2505.23885},
722731
}
723732
```
724733

725734
# ⭐ Star History
726735

727736
[![Star History Chart](https://api.star-history.com/svg?repos=camel-ai/owl&type=Date)](https://star-history.com/#camel-ai/owl&Date)
728737

729-
730-
731738
[docs-image]: https://img.shields.io/badge/Documentation-EB3ECC
732739
[docs-url]: https://camel-ai.github.io/camel/index.html
733740
[star-image]: https://img.shields.io/github/stars/camel-ai/owl?label=stars&logo=github&color=brightgreen
734741
[star-url]: https://github.com/camel-ai/owl/stargazers
735742
[package-license-image]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
736743
[package-license-url]: https://github.com/camel-ai/owl/blob/main/licenses/LICENSE
737-
738744
[colab-url]: https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing
739745
[colab-image]: https://colab.research.google.com/assets/colab-badge.svg
740746
[huggingface-url]: https://huggingface.co/camel-ai

0 commit comments

Comments
 (0)