Update README.md

README.md

@@ -14,4 +14,25 @@ size_categories:
 TODO: organize the structure
 
 * For evaluating: you can use any modelling language you want, as long as the generated final solution is in the required structure.
-* Feel free to contact us if you find any errors in models/solutions/descriptions, the dataset was mostly manually constructed, so mistakes are more than possible to exist, thank you!
+* Feel free to contact us if you find any errors in models/solutions/descriptions, the dataset was mostly manually constructed, so mistakes are more than possible to exist, thank you!
+
+# Dataset Breakdown
+
+The dataset contains problems from the following sources:
+
+- `aplai_course`: Problems from the APLAI course of KU Leuven, 2023-2024. As modelled here: https://github.com/kostis-init/LLM-CP-Modeling/tree/main/data/APLAI_course
+  - All 18 problems are added.
+- `cpmpy_examples`: Problems from the cpmpy examples folder, https://github.com/CPMpy/cpmpy/tree/master/examples
+  - All included, except for the ones that require enumeration of all solutions (e.g. `solveAll`).
+- `csplib`: Problems from the csplib, https://www.csplib.org/Problems/
+  - For now, only the ones modelled in the cpmpy repository are included (https://github.com/CPMpy/cpmpy/tree/master/examples/csplib), and the ones modelled by Hakan Kjellerstrand (http://www.hakank.org/cpmpy/).
+- `hakan_examples`: Models created by Hakan Kjellerstrand, http://www.hakank.org/cpmpy/
+  - In progress with alphabetical order. Currently, includes all problems until `TODO`, excluding the following:
+    - Those already modelled in other folders (e.g. aplai_course, cpmpy_examples, csplib)
+    - Those that contain `solveAll` (counting solutions).
+    - Global constraints tests, e.g. http://www.hakank.org/cpmpy/atmost_test.py
+
+## Diversity
+
+We attempted to include unique problems from different sources, to provide a diverse set of problems.
+However, as this was a manual process, there might be duplicates or similar problems. If you notice any, please let us know.