-
Notifications
You must be signed in to change notification settings - Fork 0
[Doc] README updates #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -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,42 +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 | ||||||||||||||||||
|
|
||||||||||||||||||
| - **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 | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Getting Started | ||||||||||||||||||
| ## For Developers | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Prerequisites | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
@@ -90,7 +49,37 @@ npm run build | |||||||||||||||||
|
|
||||||||||||||||||
| This builds the app for production to the `build` folder. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Project Structure | ||||||||||||||||||
| ### 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 | ||||||||||||||||||
| - **Routing**: React Router DOM 6.8.1 | ||||||||||||||||||
| - **Icons**: Lucide React 0.263.1 | ||||||||||||||||||
| - **Charts**: Recharts 2.8.0 | ||||||||||||||||||
|
Comment on lines
+75
to
+78
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Some of the library versions listed in the 'Web Stack' section are out of sync with the
Please update these to reflect the actual versions used in the project.
Suggested change
|
||||||||||||||||||
| - **Styling**: CSS3 with modern features | ||||||||||||||||||
| - **Build Tool**: Create React App | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Project Structure | ||||||||||||||||||
|
|
||||||||||||||||||
| ``` | ||||||||||||||||||
| src/ | ||||||||||||||||||
|
|
@@ -114,8 +103,6 @@ src/ | |||||||||||||||||
| └── index.tsx # Application entry point | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Key Components | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Router Data Structure | ||||||||||||||||||
| ```typescript | ||||||||||||||||||
| interface Router { | ||||||||||||||||||
|
|
@@ -137,14 +124,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. | ||||||||||||||||||
|
|
@@ -167,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 | ||||||||||||||||||
|
|
||||||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction for using Google Gemini for code review could be clearer. The command
/gemini reviewis typically used as a comment in a pull request on platforms like GitHub, not run in a local terminal. This phrasing might confuse contributors.