Improve model card: Add pipeline tag, paper link, abstract, code link, and usage examples

README.md

@@ -1,7 +1,124 @@
 ---
 license: mit
+pipeline_tag: reinforcement-learning
 ---
 
-# RouteFinder Checkpoints
+# RouteFinder: Towards Foundation Models for Vehicle Routing Problems
 
-You may find instructions here: https://github.com/ai4co/routefinder
+This repository contains the checkpoints for **RouteFinder**, a comprehensive foundation model framework designed to tackle different Vehicle Routing Problem (VRP) variants, as presented in the paper [RouteFinder: Towards Foundation Models for Vehicle Routing Problems](https://huggingface.co/papers/2406.15007).
+
+## Abstract
+This paper introduces RouteFinder, a comprehensive foundation model framework to tackle different Vehicle Routing Problem (VRP) variants. Our core idea is that a foundation model for VRPs should be able to represent variants by treating each as a subset of a generalized problem equipped with different attributes. We propose a unified VRP environment capable of efficiently handling any combination of these attributes. The RouteFinder model leverages a modern transformer-based encoder and global attribute embeddings to improve task representation. Additionally, we introduce two reinforcement learning techniques to enhance multi-task performance: mixed batch training, which enables training on different variants at once, and multi-variant reward normalization to balance different reward scales. Finally, we propose efficient adapter layers that enable fine-tuning for new variants with unseen attributes. Extensive experiments on 48 VRP variants show RouteFinder outperforms recent state-of-the-art learning methods. Our code is publicly available at this https URL .
+
+## Code
+The official code repository is available at: [https://github.com/ai4co/routefinder](https://github.com/ai4co/routefinder)
+
+## Model Overview
+<div align="center">
+    <img src="https://github.com/ai4co/routefinder/raw/main/assets/overview.png" alt="RouteFinder Overview" style="width: 100%; height: auto;">
+</div>
+
+## 🚀 Installation
+
+We use [uv](https://github.com/astral-sh/uv) (Python package manager) to manage the dependencies:
+
+```bash
+uv venv --python 3.12 # create a new virtual environment
+source .venv/bin/activate # activate the virtual environment
+uv sync --all-extras # for all dependencies
+```
+
+Note that this project is also compatible with normal `pip install -e .` in case you use a different package manager.
+
+## 🏁 Quickstart
+
+### Download data and checkpoints
+
+To download the data and checkpoints from HuggingFace automatically, you can use:
+
+```bash
+python scripts/download_hf.py
+```
+
+### Running
+
+We recommend exploring [this quickstart notebook](https://github.com/ai4co/routefinder/blob/main/examples/1.quickstart.ipynb) to get started with the `RouteFinder` codebase!
+
+The main runner (example here of main baseline) can be called via:
+
+```bash
+python run.py experiment=main/rf/rf-transformer-100
+```
+You may change the experiment by using the `experiment=YOUR_EXP`, with the path under [`configs/experiment`](https://github.com/ai4co/routefinder/tree/main/configs/experiment) directory.
+
+### Testing
+
+You may use the provided test function to test the model:
+
+```bash
+python test.py --checkpoint checkpoints/100/rf-transformer.ckpt
+```
+
+or with additional parameters:
+
+```
+usage: test.py [-h] --checkpoint CHECKPOINT [--problem PROBLEM] [--size SIZE] [--datasets DATASETS] [--batch_size BATCH_SIZE]
+               [--device DEVICE] [--remove-mixed-backhaul | --no-remove-mixed-backhaul]
+
+options:
+  -h, --help            show this help message and exit
+  --checkpoint CHECKPOINT
+                        Path to the model checkpoint
+  --problem PROBLEM     Problem name: cvrp, vrptw, etc. or all
+  --size SIZE           Problem size: 50, 100, for automatic loading
+  --datasets DATASETS   Filename of the dataset(s) to evaluate. Defaults to all under data/{problem}/ dir
+  --batch_size BATCH_SIZE
+  --device DEVICE
+  --remove-mixed-backhaul, --no-remove-mixed-backhaul
+                        Remove mixed backhaul instances. Use --no-remove-mixed-backhaul to keep them. (default: True)
+```
+
+We also have a notebook to automatically download and test models on the CVRPLIB [here](https://github.com/ai4co/routefinder/blob/main/examples/2.eval-cvrplib.ipynb)!
+
+## 🚚 Available Environments
+
+RouteFinder considers 48 VRP variants, which are detailed in the [GitHub repository](https://github.com/ai4co/routefinder) under the "Available Environments" section. These variants combine different features such as Capacity (C), Open Route (O), Backhaul (B), Mixed (M), Duration Limit (L), Time Windows (TW), and Multi-depot (MD).
+
+## A tip for you!
+Do you want to improve the performance of your model with no effort? Use our Transformer structure, based on recent models such as Llama and DeepSeek ;)
+
+<div align="center">
+    <img src="https://github.com/ai4co/routefinder/raw/main/assets/rf-te.png" alt="RouteFinder Transformer Structure" style="width: 50%; height: auto;">
+</div>
+
+## Known Bugs
+- For some reason, there seem to be bugs when training on M series processors from Apple (but not during inference somehow?). We recommend training with a discrete GPU. We'll keep you posted with updates!
+
+## 🤗 Acknowledgements
+- https://github.com/FeiLiu36/MTNCO/tree/main
+- https://github.com/RoyalSkye/Routing-MVMoE
+- https://github.com/yd-kwon/POMO
+- https://github.com/ai4co/rl4co
+
+## 🤩 Citation
+If you find RouteFinder valuable for your research or applied projects:
+
+```bibtex
+@article{
+berto2025routefinder,
+title={{RouteFinder: Towards Foundation Models for Vehicle Routing Problems}},
+author={Federico Berto and Chuanbo Hua and Nayeli Gast Zepeda and Andr{\'e} Hottung and Niels Wouda and Leon Lan and Junyoung Park and Kevin Tierney and Jinkyoo Park},
+journal={Transactions on Machine Learning Research},
+issn={2835-8856},
+year={2025},
+url={https://openreview.net/forum?id=QzGLoaOPiY},
+}
+```
+
+---
+
+<div align="center">
+    <a href="https://github.com/ai4co">
+        <img src="https://raw.githubusercontent.com/ai4co/assets/main/svg/ai4co_animated_full.svg" alt="AI4CO Logo" style="width: 30%; height: auto;">
+    </a>
+</div>