Minwei Kong commited on
Commit
6d5cab6
·
verified ·
1 Parent(s): aa2a8a3

Refresh README for FrontierOR-v1 update

Browse files
Files changed (1) hide show
  1. README.md +37 -24
README.md CHANGED
@@ -30,20 +30,23 @@ Designed for evaluating LLMs on the end-to-end task of turning a research
30
  paper's OR problem into runnable, verifiably-correct optimization code.
31
 
32
 
33
- ## Dataset size note
34
 
35
- This repository now contains 180 canonical tasks under `tasks/`. The legacy `ostrowski2012` compatibility alias, which duplicated `earl2005`, was removed on 2026-09-06.
36
-
37
- ## FrontierOR-v1 release notes
38
-
39
- FrontierOR-v1 includes an important dataset update that consolidates the canonical task set, Gurobi references, hard-set split metadata, feasibility checkers, and task-instance artifacts. For detailed notes on the fixes and compatibility changes, see [`RELEASE_NOTES.md`](RELEASE_NOTES.md).
40
 
41
  ## Layout
42
 
43
  | Path | Purpose |
44
  | --- | --- |
 
 
 
 
 
45
  | `metadata/paper_meta_info.json` | Metadata for all 180 canonical papers, including optimization direction |
46
- | `tasks/<paper_id>/` | Self-contained task package for one paper |
 
 
47
 
48
  ## What's in each task folder
49
 
@@ -56,22 +59,11 @@ FrontierOR-v1 includes an important dataset update that consolidates the canonic
56
  | `solution_logger.py` | Utility for serializing solutions |
57
  | `instance_schema.json` | JSON schema for input instances |
58
  | `solution_schema.json` | JSON schema for solutions |
59
- | `instance/` | Test instances (JSON) |
60
- | `gurobi_solution/` | Reference solutions produced by `gurobi_code.py` |
61
- | `gurobi_solution_log/` | Anytime objective trajectory from the reference Gurobi run |
62
- | `gurobi_feasi_result/` | Output of `feasibility_check.py` on the reference solutions |
63
-
64
- <!-- ## Top-level files
65
-
66
- - `paper_meta_info.csv` / `paper_meta_info.json` — metadata for all 180 papers
67
- (problem class, formulation type, application field, average instance size, etc.). -->
68
-
69
- <!-- ## Source PDFs
70
-
71
- The original paper PDFs are **not redistributed** here because copyright belongs
72
- to the respective publishers (INFORMS, Elsevier, Springer, etc.). Use the
73
- `paper_id`, `paper_title`, `publication`, and `year` columns in
74
- `paper_meta_info.csv` to look them up via your institution. -->
75
 
76
  ## Loading the metadata
77
 
@@ -84,12 +76,33 @@ print(meta[0])
84
  For the per-paper instance / solution data, clone or download the full
85
  repository — the structure is intentionally a file tree, not a flat HF
86
  dataset, because each paper is its own reproducible package under
87
- `tasks/<paper_id>/`.
 
 
 
 
 
 
 
 
88
 
89
  ```bash
90
  hf download SmartOR/FrontierOR --repo-type dataset --local-dir frontier-or
91
  ```
92
 
 
 
 
 
 
 
 
 
 
 
 
 
 
93
  <!-- ## License
94
 
95
  Released under **CC-BY-4.0**. If you use this benchmark, please cite the
 
30
  paper's OR problem into runnable, verifiably-correct optimization code.
31
 
32
 
33
+ ## **📌 FrontierOR-v1 release notes**
34
 
35
+ **FrontierOR-v1 was updated on 2026-09-27.** This important dataset update consolidates the canonical 180-task collection, Gurobi references, hard-set split metadata, feasibility checkers, and task-instance artifacts. For detailed fixes and compatibility notes, see [`RELEASE_NOTES.md`](RELEASE_NOTES.md).
 
 
 
 
36
 
37
  ## Layout
38
 
39
  | Path | Purpose |
40
  | --- | --- |
41
+ | `README.md` | Dataset overview and loading instructions |
42
+ | `RELEASE_NOTES.md` | Detailed FrontierOR-v1 update notes |
43
+ | `CASE_IDS.txt` | Canonical task id list |
44
+ | `LICENSE.md` | Dataset license |
45
+ | `metadata/` | Paper metadata, Gurobi reference summaries, and benchmark split metadata |
46
  | `metadata/paper_meta_info.json` | Metadata for all 180 canonical papers, including optimization direction |
47
+ | `metadata/gurobi_references.parquet` / `.csv.gz` | Canonical Gurobi objectives, runtimes, statuses, and related reference fields |
48
+ | `metadata/splits/` | Hard-set ids, ranking inputs, methodology, and reproduction script |
49
+ | `tasks/<task_id>/` | Self-contained task package for one paper |
50
 
51
  ## What's in each task folder
52
 
 
59
  | `solution_logger.py` | Utility for serializing solutions |
60
  | `instance_schema.json` | JSON schema for input instances |
61
  | `solution_schema.json` | JSON schema for solutions |
62
+ | `instance/` | Six benchmark instances: `tiny_instance.json` and `large_instance_1.json` through `large_instance_5.json` |
63
+ | `gurobi_solution/` | Reference Gurobi solutions for the tiny and five large instances |
64
+ | `gurobi_solution_log/` | Anytime incumbent objective trajectories from the reference Gurobi runs |
65
+ | `gurobi_feasi_result/` | Feasibility-check outputs for the reference Gurobi solutions |
66
+ | `solverless_models/` | Optional task-local assets for checkers that need solver-independent validation models |
 
 
 
 
 
 
 
 
 
 
 
67
 
68
  ## Loading the metadata
69
 
 
76
  For the per-paper instance / solution data, clone or download the full
77
  repository — the structure is intentionally a file tree, not a flat HF
78
  dataset, because each paper is its own reproducible package under
79
+ `tasks/<task_id>/`.
80
+
81
+ ```bash
82
+ hf download SmartOR/FrontierOR --repo-type dataset --local-dir frontier-or
83
+ ```
84
+
85
+ To update an existing local copy without downloading everything from scratch,
86
+ rerun the same command; unchanged files are reused from the Hugging Face cache
87
+ and only missing or changed files are fetched.
88
 
89
  ```bash
90
  hf download SmartOR/FrontierOR --repo-type dataset --local-dir frontier-or
91
  ```
92
 
93
+ If your local copy was created by `git clone`, update it with:
94
+
95
+ ```bash
96
+ cd frontier-or
97
+ git pull
98
+ git lfs pull
99
+ ```
100
+
101
+ When upgrading from an older snapshot, note that files deleted upstream may
102
+ remain in an existing `--local-dir` checkout. Remove stale top-level files
103
+ manually if present, or refresh from a clean directory when exact directory
104
+ parity is required.
105
+
106
  <!-- ## License
107
 
108
  Released under **CC-BY-4.0**. If you use this benchmark, please cite the