add changelog of changed instances

cp_bench_changes.md

@@ -0,0 +1,152 @@
+# Verifying CP-bench: Changelog
+
+Here is a summary of the changes made to the CP-bench dataset, focusing on the removal of instances with critical issues.
+The resulted verified dataset is available in `dataset_verified.jsonl`.
+
+### Symmetry-Breaking Constraints Removed
+
+- `csplib/csplib_002_template_design.py`
+- `csplib/csplib_006_golomb_rulers.py`
+- `csplib/csplib_007_all_interval.py`
+- `csplib/csplib_010_social_golfers_problem.py`
+- `csplib/csplib_019_magic_squares_and_sequences.py`
+- `csplib/csplib_024_langford.py`
+- `csplib/csplib_028_bibd.py`
+- `csplib/csplib_033_word_design.py`
+- `csplib/csplib_044_steiner.py`
+- `csplib/csplib_049_number_partitioning.py`
+- `csplib/csplib_050_diamond_free.py`
+- `csplib/csplib_076_costas_arrays.py`
+- `hakan_examples/age_changing.py`
+- `hakan_examples/bales_of_hay.py`
+- `hakan_examples/best_host.py`
+- `hakan_examples/big_bang2.py`
+- `hakan_examples/bowls_and_oranges.py`
+- `hakan_examples/broken_weights.py`
+- `hakan_examples/building_blocks.py`
+- `hakan_examples/calvin_puzzle.py`
+- `hakan_examples/circular_table_averbach_1_2.py`
+- `hakan_examples/clock_triplets.py`
+
+### Modeling Errors Corrected
+
+**Major Modeling Errors:**
+- `cpmpy_examples/mario.py`
+- `csplib/csplib_026_sports_tournament_scheduling.py`
+- `hakan_examples/circular_table_averbach_1_2.py`
+
+**Domain Errors:**
+
+- `hakan_examples/among.py`
+- `hakan_examples/birthday_coins.py`
+- `hakan_examples/cmo_2012.py`
+
+**Minor Modeling Errors (e.g., underconstrained models):**
+- `csplib/csplib_001_car_sequencing.py`
+- `csplib/csplib_013_progressive_party_problem.py`
+- `csplib/csplib_033_word_design.py`
+- `hakan_examples/facility_location.py`
+
+
+### Description or Data Underspecification (e.g.,  indexing, matrix orientation, missing data, etc.)
+
+- `aplai_course/exodus.py`
+- `cpmpy_examples/knapsack.py`
+- `cpmpy_examples/mario.py`
+- `cpmpy_examples/n_puzzle.py`
+- `cpmpy_examples/tsp.py`
+- `csplib/csplib_007_all_interval.py`
+- `csplib/csplib_011_acc_basketball_schedule.py`
+- `csplib/csplib_013_progressive_party_problem.py`
+- `csplib/csplib_026_sports_tournament_scheduling.py`
+- `csplib/csplib_054_n_queens.py`
+- `hakan_examples/among.py`
+- `hakan_examples/arch_friends.py`
+- `hakan_examples/bananas.py`
+- `hakan_examples/big_bang2.py`
+- `hakan_examples/crew.py`
+- `hakan_examples/three_coins.py`
+
+### Minor Description Changes (e.g. typos, clarity)
+
+- `aplai_course/color_simple.py`
+- `aplai_course/grocery.py`
+- `aplai_course/guards_and_apples.py`
+- `aplai_course/magic_square.py`
+- `aplai_course/maximal_independent_sets.py`
+- `aplai_course/money_change.py`
+- `aplai_course/movie_scheduling.py`
+- `aplai_course/people_in_a_room.py`
+- `aplai_course/subset_sum.py`
+- `cpmpy_examples/bus_scheduling.py`
+- `cpmpy_examples/minesweeper.py`
+- `cpmpy_examples/packing_rectangles.py`
+- `cpmpy_examples/resource_constrained_project_scheduling.py`
+- `cpmpy_examples/room_assignment.py`
+- `cpmpy_examples/set_game.py`
+- `cpmpy_examples/sudoku.py`
+- `cpmpy_examples/tsp.py`
+- `cpmpy_examples/who_killed_agatha.py`
+- `cpmpy_examples/zebra.py`
+- `csplib/csplib_002_template_design.py`
+- `csplib/csplib_005_autocorrelation.py`
+- `csplib/csplib_006_golomb_rulers.py`
+- `csplib/csplib_008_vessel_loading.py`
+- `csplib/csplib_009_perfect_square_placement.py`
+- `csplib/csplib_010_social_golfers_problem.py`
+- `csplib/csplib_012_nonogram.py`
+- `csplib/csplib_021_crossfigures.py`
+- `csplib/csplib_024_langford.py`
+- `csplib/csplib_028_bibd.py`
+- `csplib/csplib_033_word_design.py`
+- `csplib/csplib_050_diamond_free.py`
+- `csplib/csplib_084_hadamard_matrix.py`
+- `hakan_examples/added_corners.py`
+- `hakan_examples/appointment_scheduling.py`
+- `hakan_examples/archery_puzzle.py`
+- `hakan_examples/assignment_costs.py`
+- `hakan_examples/bales_of_hay.py`
+- `hakan_examples/best_host.py`
+- `hakan_examples/bin_packing.py`
+- `hakan_examples/broken_weights.py`
+- `hakan_examples/calvin_puzzle.py`
+- `hakan_examples/capital_budget.py`
+- `hakan_examples/clock_triplets.py`
+- `hakan_examples/coins_grid.py`
+- `hakan_examples/covering_opl.py`
+- `hakan_examples/crossword.py`
+- `hakan_examples/crypta.py`
+- `hakan_examples/eighteen_hole_golf.py`
+- `hakan_examples/facility_location.py`
+- `hakan_examples/three_sum.py`
+- `hakan_examples/twelve_pack.py`
+
+### Unnecessary Information Removed
+
+- `cpmpy_examples/jobshop.py`
+- `cpmpy_examples/n_puzzle.py`
+- `cpmpy_examples/send_more_money.py`
+- `csplib/csplib_001_car_sequencing.py`
+- `csplib/csplib_002_template_design.py`
+- `csplib/csplib_005_autocorrelation.py`
+- `csplib/csplib_006_golomb_rulers.py`
+- `csplib/csplib_007_all_interval.py`
+- `csplib/csplib_008_vessel_loading.py`
+- `csplib/csplib_009_perfect_square_placement.py`
+- `csplib/csplib_010_social_golfers_problem.py`
+- `csplib/csplib_011_acc_basketball_schedule.py`
+- `csplib/csplib_012_nonogram.py`
+- `csplib/csplib_013_progressive_party_problem.py`
+- `csplib/csplib_015_schurs_lemma.py`
+- `csplib/csplib_019_magic_squares_and_sequences.py`
+- `csplib/csplib_024_langford.py`
+- `csplib/csplib_026_sports_tournament_scheduling.py`
+- `csplib/csplib_028_bibd.py`
+- `csplib/csplib_033_word_design.py`
+- `csplib/csplib_044_steiner.py`
+- `csplib/csplib_049_number_partitioning.py`
+- `csplib/csplib_050_diamond_free.py`
+- `csplib/csplib_053_graceful_graphs.py`
+- `csplib/csplib_054_n_queens.py`
+- `csplib/csplib_076_costas_arrays.py`
+- `csplib/csplib_084_hadamard_matrix.py`