SearchArena / README.md
LeoWalker's picture
cleaned up the read me and readability of app/helpers
9a1b773
|
raw
history blame
1.52 kB
metadata
title: SearchArena
emoji: 🐠
colorFrom: red
colorTo: gray
sdk: streamlit
sdk_version: 1.35.0
app_file: app.py
pinned: false

Search Arena

Search Arena is a comprehensive platform designed to evaluate and compare search-based web agents. Leveraging a variety of metrics, Search Arena ensures that users can identify the most effective solutions for their needs.

Getting Started

Follow these steps to set up the project on your local machine.

Prerequisites

  • Git
  • Python 3.x
  • Virtualenv (optional but recommended)

Installation

  1. Clone the Repository:

    git clone https://github.com/leowalker89/SearchArena
    
  2. Navigate to the Project Directory:

    cd search-arena
    
  3. Create a Virtual Environment:

    python -m venv env
    
  4. Activate the Virtual Environment:

    • On Windows:

      .\env\Scripts\activate
      
    • On macOS and Linux:

      source env/bin/activate
      
  5. Install the Required Dependencies:

    pip install -r requirements.txt
    

Running the Project

  1. Start the Development Server:

    streamlit run app.py
    
  2. Open your Browser:

    Navigate to http://localhost:5000 to view the platform.

Usage

  • Follow the on-screen instructions to evaluate and compare search-based web agents.

License

This project is licensed under the MIT License. See the LICENSE file for more details.