From 09d5df759a1939aaff7acced7f42d376ad9c4eee Mon Sep 17 00:00:00 2001 From: jiarong0907 Date: Sun, 26 Oct 2025 00:18:08 -0500 Subject: [PATCH 1/4] remove not needed info --- README.md | 46 +++------------------------------------------- 1 file changed, 3 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 4fd8dc0..2c34a29 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,6 @@ - # Project Overview -RouterArena is the first open platform enabling comprehensive evaluation and comparison of LLM routers. The platform features: - -- **Principled Dataset**: 8,400 queries across 9 domains and 44 categories using Dewey Decimal Classification and Bloom's taxonomy -- **Multi-Dimensional Metrics**: Arena Score, Cost Ratio, Optimality, Latency, and Robustness evaluation -- **Automated Framework**: Support for both academic and commercial routers with real-time leaderboard updates -- **Fair Comparison**: Unified evaluation protocol for transparent and reproducible results +RouterArena is the first open platform enabling comprehensive evaluation and comparison of LLM routers. Check out the [website](https://routeworks.github.io) for more details. ## Research Team @@ -20,33 +14,7 @@ RouterArena is the first open platform enabling comprehensive evaluation and com - Hongyi Liu (hl87@rice.edu) - Jiarong Xing (jxing@rice.edu) -## Website Features - -### 🏠 Home Page -- Project overview and key features -- Dataset statistics and difficulty levels -- Contact information and collaboration details -- Interactive leaderboard preview - -### 🏆 Leaderboard Page -- Comprehensive router rankings across multiple metrics -- Search and filter functionality -- Detailed performance metrics for each router -- Links to papers and source code - -### 📝 Submit Page -- Router submission form for evaluation -- Clear guidelines for academic and commercial routers -- Evaluation process explanation -- Contact information for collaboration - -### ℹī¸ About Page -- Detailed project methodology -- Research team information -- Citation information -- Contact and collaboration details - -## Technology Stack +## Web Stack - **Frontend**: React 19.2.0 with TypeScript - **Routing**: React Router DOM 6.8.1 @@ -55,7 +23,7 @@ RouterArena is the first open platform enabling comprehensive evaluation and com - **Styling**: CSS3 with modern features - **Build Tool**: Create React App -## Getting Started +## For Developers ### Prerequisites @@ -137,14 +105,6 @@ interface Router { } ``` -### Evaluation Metrics - -1. **Arena Score**: Overall performance combining accuracy and cost efficiency -2. **Cost Ratio Score**: Efficiency in cost optimization relative to optimal routing -3. **Optimality Score**: Frequency of selecting the most efficient model for each query -4. **Latency Score**: Router overhead and response time performance -5. **Robustness Score**: Stability against query perturbations and noise - ## Contributing We welcome contributions to the RouterArena platform! Please see our submission guidelines on the website or contact us directly. From 51b48407fa8d20058729fe3505a40337977d932b Mon Sep 17 00:00:00 2001 From: Jiarong Xing <42587491+jiarong0907@users.noreply.github.com> Date: Sun, 26 Oct 2025 00:20:21 -0500 Subject: [PATCH 2/4] Reorganize README sections for clarity Reorganized the README to include the Web Stack section before Project Structure and removed the old Web Stack section. --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2c34a29..0ca6307 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,6 @@ RouterArena is the first open platform enabling comprehensive evaluation and com - Hongyi Liu (hl87@rice.edu) - Jiarong Xing (jxing@rice.edu) -## Web Stack - -- **Frontend**: React 19.2.0 with TypeScript -- **Routing**: React Router DOM 6.8.1 -- **Icons**: Lucide React 0.263.1 -- **Charts**: Recharts 2.8.0 -- **Styling**: CSS3 with modern features -- **Build Tool**: Create React App - ## For Developers ### Prerequisites @@ -58,7 +49,16 @@ npm run build This builds the app for production to the `build` folder. -## Project Structure +### Web Stack + +- **Frontend**: React 19.2.0 with TypeScript +- **Routing**: React Router DOM 6.8.1 +- **Icons**: Lucide React 0.263.1 +- **Charts**: Recharts 2.8.0 +- **Styling**: CSS3 with modern features +- **Build Tool**: Create React App + +### Project Structure ``` src/ @@ -82,8 +82,6 @@ src/ └── index.tsx # Application entry point ``` -## Key Components - ### Router Data Structure ```typescript interface Router { From 7f25e3786271642f88d2a7dadb9c552e5060fc21 Mon Sep 17 00:00:00 2001 From: jiarong0907 Date: Sun, 26 Oct 2025 00:23:20 -0500 Subject: [PATCH 3/4] pre-commit instruction --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 0ca6307..7574d03 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,27 @@ npm run build This builds the app for production to the `build` folder. +### Coding/PR Style Check + +We use pre-commit to ensure a consistent coding style. You can set it up by + +``` +pip install pre-commit +pre-commit install +``` + +Before pushing your code, please run the following check and make sure your code passes all checks. + +``` +pre-commit run --all-files +``` + +We have set up Google Gemini to review your code. You can use it by running the following command: + +``` +/gemini review +``` + ### Web Stack - **Frontend**: React 19.2.0 with TypeScript From d52f7418cf70baac088a7e44b1fa442b334b80b8 Mon Sep 17 00:00:00 2001 From: Jiarong Xing <42587491+jiarong0907@users.noreply.github.com> Date: Sun, 26 Oct 2025 00:24:03 -0500 Subject: [PATCH 4/4] Add additional contact email to README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7574d03..bd8d64e 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ If you use RouterArena in your research, please cite our paper: ## Contact -- **Email**: yifan.lu@rice.edu +- **Email**: yifan.lu@rice.edu, jxing@rice.edu - **Paper**: https://www.arxiv.org/abs/2510.00202 ## Acknowledgments