From c2eaf9ddb860a866bb1fd05013b53b407c6e8b2c Mon Sep 17 00:00:00 2001 From: lazychih114 <55657767+Aaron617@users.noreply.github.com> Date: Wed, 7 May 2025 10:18:59 +0800 Subject: [PATCH] update readme for gaia users --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index e31d00c..f75ab71 100644 --- a/README.md +++ b/README.md @@ -67,10 +67,41 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas - [๐ŸŽฌ Demo Video](#-demo-video) - [โœจ๏ธ Core Features](#๏ธ-core-features) - [๐Ÿ› ๏ธ Installation](#๏ธ-installation) + - [**Prerequisites**](#prerequisites) + - [Install Python](#install-python) + - [**Installation Options**](#installation-options) + - [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended) + - [Option 2: Using venv and pip](#option-2-using-venv-and-pip) + - [Option 3: Using conda](#option-3-using-conda) + - [Option 4: Using Docker](#option-4-using-docker) + - [**Using Pre-built Image (Recommended)**](#using-pre-built-image-recommended) + - [**Building Image Locally**](#building-image-locally) + - [**Using Convenience Scripts**](#using-convenience-scripts) + - [**Setup Environment Variables**](#setup-environment-variables) + - [Setting Environment Variables Directly](#setting-environment-variables-directly) + - [Alternative: Using a `.env` File](#alternative-using-a-env-file) + - [**MCP Desktop Commander Setup**](#mcp-desktop-commander-setup) - [๐Ÿš€ Quick Start](#-quick-start) + - [Basic Usage](#basic-usage) + - [Running with Different Models](#running-with-different-models) + - [Model Requirements](#model-requirements) + - [Supported Models](#supported-models) + - [Example Tasks](#example-tasks) - [๐Ÿงฐ Toolkits and Capabilities](#-toolkits-and-capabilities) - [Model Context Protocol (MCP)](#model-context-protocol-mcp) + - [**Install Node.js**](#install-nodejs) + - [Windows](#windows) + - [Linux](#linux) + - [Mac](#mac) + - [**Install Playwright MCP Service**](#install-playwright-mcp-service) + - [Available Toolkits](#available-toolkits) + - [Available Toolkits](#available-toolkits-1) + - [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities) + - [Text-Based Toolkits](#text-based-toolkits) + - [Customizing Your Configuration](#customizing-your-configuration) - [๐ŸŒ Web Interface](#-web-interface) + - [Starting the Web UI](#starting-the-web-ui) + - [Features](#features) - [๐Ÿงช Experiments](#-experiments) - [โฑ๏ธ Future Plans](#๏ธ-future-plans) - [๐Ÿ“„ License](#-license) @@ -79,6 +110,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas - [๐Ÿ”ฅ Community](#-community) - [โ“ FAQ](#-faq) - [๐Ÿ“š Exploring CAMEL Dependency](#-exploring-camel-dependency) + - [Accessing CAMEL Source Code](#accessing-camel-source-code) - [โญ Star History](#-star-history) # ๐Ÿ”ฅ News @@ -151,6 +183,8 @@ This video demonstrates how to install OWL locally and showcases its capabilitie ### Install Python Before installing OWL, ensure you have Python installed (version 3.10, 3.11, or 3.12 is supported): +> **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. + ```bash # Check if Python is installed python --version