Update README.md file
#1
by VictorMiranda09 - opened
README.md
CHANGED
|
@@ -1,13 +1,106 @@
|
|
| 1 |
-
---
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
-
|
| 9 |
-
- vehicle-routing
|
| 10 |
-
--
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
license: mit
|
| 5 |
+
pretty_name: MAEnvs4VRP Datasets
|
| 6 |
+
tags:
|
| 7 |
+
- reinforcement-learning
|
| 8 |
+
- combinatorial-optimization
|
| 9 |
+
- vehicle-routing-problem
|
| 10 |
+
- operations-research
|
| 11 |
+
- multi-agent
|
| 12 |
+
- dataset
|
| 13 |
+
task_categories:
|
| 14 |
+
- reinforcement-learning
|
| 15 |
+
size_categories:
|
| 16 |
+
- unknown
|
| 17 |
+
---
|
| 18 |
+
|
| 19 |
+
<p align="center">
|
| 20 |
+
<img src="https://raw.githubusercontent.com/MAEnvs4VRP/maenvs4vrp/master/docs/source/img/banner.png" width="600" />
|
| 21 |
+
</p>
|
| 22 |
+
|
| 23 |
+
Main code on Github: https://github.com/MAEnvs4VRP/maenvs4vrp
|
| 24 |
+
|
| 25 |
+
|
| 26 |
+
## MAEnvs4VRP Datasets
|
| 27 |
+
|
| 28 |
+
The **MAEnvs4VRP Datasets** repository provides benchmark and synthetic datasets for the vehicle routing problems (VRPs) supported by the **MAEnvs4VRP** framework.
|
| 29 |
+
|
| 30 |
+
The repository is intended to serve as a centralized collection of routing instances for training, validating, and benchmarking reinforcement learning algorithms and other optimization methods on classical and advanced Vehicle Routing Problems.
|
| 31 |
+
|
| 32 |
+
The datasets are fully compatible with the MAEnvs4VRP library and can be used to reproduce experiments, evaluate new learning algorithms, and compare optimization approaches across multiple VRP variants.
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
# Supported Vehicle Routing Problems
|
| 37 |
+
|
| 38 |
+
The repository contains datasets for several routing problems implemented in MAEnvs4VRP, including:
|
| 39 |
+
|
| 40 |
+
| Problem | Description |
|
| 41 |
+
|----------|-------------|
|
| 42 |
+
| CVRP | Capacitated Vehicle Routing Problem |
|
| 43 |
+
| CVRPSTW | Capacitated Vehicle Routing Problem with Time Windows |
|
| 44 |
+
| CVRPTW | Capacitated Vehicle Routing Problem with Soft Time Windows |
|
| 45 |
+
| PDPTW | Pickup and Delivery Problem with Time Windows |
|
| 46 |
+
| SDVRPTW | Split Delivery Vehicle Routing Problem with Time Windows |
|
| 47 |
+
| TOP | Team Orienteering Problem |
|
| 48 |
+
| TOPTW | Team Orienteering Problem with Time Windows |
|
| 49 |
+
|
| 50 |
+
---
|
| 51 |
+
|
| 52 |
+
# Using the Datasets
|
| 53 |
+
|
| 54 |
+
The datasets provided in this repository are designed to be used with the **MAEnvs4VRP** framework.
|
| 55 |
+
|
| 56 |
+
Benchmark instances are automatically downloaded from the Hugging Face Hub when required by the corresponding environment. After the initial download, the datasets are cached locally and reused in future executions.
|
| 57 |
+
|
| 58 |
+
Each environment in MAEnvs4VRP provides the appropriate instance generator for loading and sampling benchmark instances. Refer to the documentation of the corresponding environment for usage examples and configuration options.
|
| 59 |
+
|
| 60 |
+
---
|
| 61 |
+
|
| 62 |
+
# Relationship with MAEnvs4VRP
|
| 63 |
+
|
| 64 |
+
This repository complements the **MAEnvs4VRP** library by providing the datasets used by its environments.
|
| 65 |
+
|
| 66 |
+
The library implements simulation environments for multiple Vehicle Routing Problems, while this repository stores the corresponding benchmark and synthetic routing instances.
|
| 67 |
+
|
| 68 |
+
---
|
| 69 |
+
|
| 70 |
+
# Limitations
|
| 71 |
+
|
| 72 |
+
Users should be aware that:
|
| 73 |
+
|
| 74 |
+
- different routing problems contain different data schemas;
|
| 75 |
+
- not every environment currently includes the same number of benchmark instances;
|
| 76 |
+
- additional datasets may be incorporated in future releases;
|
| 77 |
+
- synthetic datasets are generated according to the assumptions of their corresponding environment.
|
| 78 |
+
|
| 79 |
+
---
|
| 80 |
+
|
| 81 |
+
# Citation
|
| 82 |
+
|
| 83 |
+
If you use these datasets in your research, please cite the MAEnvs4VRP paper.
|
| 84 |
+
|
| 85 |
+
```bibtex
|
| 86 |
+
@article{maenvs4vrp,
|
| 87 |
+
title={MAEnvs4VRP: Multi-Agent Environments for Vehicle Routing Problems},
|
| 88 |
+
author={}
|
| 89 |
+
year={2026},
|
| 90 |
+
journal={INFORMS Journal on Computing},
|
| 91 |
+
}
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
---
|
| 95 |
+
|
| 96 |
+
# License
|
| 97 |
+
|
| 98 |
+
This dataset is distributed under the MIT License unless otherwise specified for individual benchmark collections.
|
| 99 |
+
|
| 100 |
+
Users should also acknowledge the original authors of benchmark datasets whenever applicable.
|
| 101 |
+
|
| 102 |
+
---
|
| 103 |
+
|
| 104 |
+
# Acknowledgements
|
| 105 |
+
|
| 106 |
+
This repository is part of the **MAEnvs4VRP** project, which provides a unified framework for developing and evaluating reinforcement learning algorithms for Vehicle Routing Problems.
|