Skip to content

Commit bb3a791

Browse files
authored
[Doc] README updates (#3)
* remove not needed info * Reorganize README sections for clarity Reorganized the README to include the Web Stack section before Project Structure and removed the old Web Stack section. * pre-commit instruction * Add additional contact email to README
1 parent 138a8d2 commit bb3a791

1 file changed

Lines changed: 34 additions & 55 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
21
# Project Overview
32

4-
RouterArena is the first open platform enabling comprehensive evaluation and comparison of LLM routers. The platform features:
5-
6-
- **Principled Dataset**: 8,400 queries across 9 domains and 44 categories using Dewey Decimal Classification and Bloom's taxonomy
7-
- **Multi-Dimensional Metrics**: Arena Score, Cost Ratio, Optimality, Latency, and Robustness evaluation
8-
- **Automated Framework**: Support for both academic and commercial routers with real-time leaderboard updates
9-
- **Fair Comparison**: Unified evaluation protocol for transparent and reproducible results
3+
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.
104

115
## Research Team
126

@@ -20,42 +14,7 @@ RouterArena is the first open platform enabling comprehensive evaluation and com
2014
- Hongyi Liu (hl87@rice.edu)
2115
- Jiarong Xing (jxing@rice.edu)
2216

23-
## Website Features
24-
25-
### 🏠 Home Page
26-
- Project overview and key features
27-
- Dataset statistics and difficulty levels
28-
- Contact information and collaboration details
29-
- Interactive leaderboard preview
30-
31-
### 🏆 Leaderboard Page
32-
- Comprehensive router rankings across multiple metrics
33-
- Search and filter functionality
34-
- Detailed performance metrics for each router
35-
- Links to papers and source code
36-
37-
### 📝 Submit Page
38-
- Router submission form for evaluation
39-
- Clear guidelines for academic and commercial routers
40-
- Evaluation process explanation
41-
- Contact information for collaboration
42-
43-
### ℹ️ About Page
44-
- Detailed project methodology
45-
- Research team information
46-
- Citation information
47-
- Contact and collaboration details
48-
49-
## Technology Stack
50-
51-
- **Frontend**: React 19.2.0 with TypeScript
52-
- **Routing**: React Router DOM 6.8.1
53-
- **Icons**: Lucide React 0.263.1
54-
- **Charts**: Recharts 2.8.0
55-
- **Styling**: CSS3 with modern features
56-
- **Build Tool**: Create React App
57-
58-
## Getting Started
17+
## For Developers
5918

6019
### Prerequisites
6120

@@ -90,7 +49,37 @@ npm run build
9049

9150
This builds the app for production to the `build` folder.
9251

93-
## Project Structure
52+
### Coding/PR Style Check
53+
54+
We use pre-commit to ensure a consistent coding style. You can set it up by
55+
56+
```
57+
pip install pre-commit
58+
pre-commit install
59+
```
60+
61+
Before pushing your code, please run the following check and make sure your code passes all checks.
62+
63+
```
64+
pre-commit run --all-files
65+
```
66+
67+
We have set up Google Gemini to review your code. You can use it by running the following command:
68+
69+
```
70+
/gemini review
71+
```
72+
73+
### Web Stack
74+
75+
- **Frontend**: React 19.2.0 with TypeScript
76+
- **Routing**: React Router DOM 6.8.1
77+
- **Icons**: Lucide React 0.263.1
78+
- **Charts**: Recharts 2.8.0
79+
- **Styling**: CSS3 with modern features
80+
- **Build Tool**: Create React App
81+
82+
### Project Structure
9483

9584
```
9685
src/
@@ -114,8 +103,6 @@ src/
114103
└── index.tsx # Application entry point
115104
```
116105

117-
## Key Components
118-
119106
### Router Data Structure
120107
```typescript
121108
interface Router {
@@ -137,14 +124,6 @@ interface Router {
137124
}
138125
```
139126

140-
### Evaluation Metrics
141-
142-
1. **Arena Score**: Overall performance combining accuracy and cost efficiency
143-
2. **Cost Ratio Score**: Efficiency in cost optimization relative to optimal routing
144-
3. **Optimality Score**: Frequency of selecting the most efficient model for each query
145-
4. **Latency Score**: Router overhead and response time performance
146-
5. **Robustness Score**: Stability against query perturbations and noise
147-
148127
## Contributing
149128

150129
We welcome contributions to the RouterArena platform! Please see our submission guidelines on the website or contact us directly.
@@ -167,7 +146,7 @@ If you use RouterArena in your research, please cite our paper:
167146

168147
## Contact
169148

170-
- **Email**: yifan.lu@rice.edu
149+
- **Email**: yifan.lu@rice.edu, jxing@rice.edu
171150
- **Paper**: https://www.arxiv.org/abs/2510.00202
172151

173152
## Acknowledgments

0 commit comments

Comments
 (0)