kostis-init commited on
Commit
a119cd7
Β·
1 Parent(s): 2e3b478

update submission guidelines in UI text and add template script link

Browse files
Files changed (2) hide show
  1. src/ui.py +5 -4
  2. template.py +1 -0
src/ui.py CHANGED
@@ -81,17 +81,18 @@ def create_ui():
81
  "## How to Submit\n"
82
  "1. **Name your submission**: Choose a unique name for your submission (e.g., `my_cool_submission`). "
83
  "This name will be used to identify your submission on the leaderboard.\n"
84
- "2. **Upload a PDF report**: This is optional, but we highly encourage you to upload a report "
 
85
  " (in PDF format) describing your approach. As this is an open competition, we want to avoid submissions "
86
  " that just copy the models from the dataset. The report can be a short description of your approach, "
87
  " the models you generated, and any other relevant information.\n"
88
- "3. **Upload your submission**: Upload a **single** `.jsonl` file containing the generated models. "
89
  " **Each line in the file should be a JSON object with two keys: `id` and `model`.**\n"
90
  " * `id`: The ID of the problem exactly as it appears in the original dataset (e.g., `csplib__csplib_001_car_sequencing`).\n"
91
  " * `model`: The generated model for the problem (as a string representing runnable code). Make sure that it eventually outputs the solution as a json with key(s) as described in the `decision_variables` entry and values as would be expected in the problem. This is part of the evaluation as well: unexpected keys, or value types are considered incorrect. This is because our automatic evaluation is based on the solution printed by the submitted models.\n"
92
  " * An example submission file can be found [here](https://huggingface.co/spaces/kostis-init/CP-Bench-competition/blob/main/sample_submission.jsonl).\n"
93
- "3. **Check the leaderboard**: After uploading, you can check the leaderboard to see your results. "
94
- "It may take a few minutes for a submission to be evaluated and appear on the leaderboard.\n"
95
  "\n\n"
96
  "## Important Notes\n"
97
  "1. **Submission Name**: The submission name must be different from any existing submission names.\n"
 
81
  "## How to Submit\n"
82
  "1. **Name your submission**: Choose a unique name for your submission (e.g., `my_cool_submission`). "
83
  "This name will be used to identify your submission on the leaderboard.\n"
84
+ "2. **Select the modelling framework**: Indicate which modelling framework your submission uses (e.g., MiniZinc, CPMpy, OR-Tools).\n"
85
+ "3. **Upload a PDF report**: This is optional, but we highly encourage you to upload a report "
86
  " (in PDF format) describing your approach. As this is an open competition, we want to avoid submissions "
87
  " that just copy the models from the dataset. The report can be a short description of your approach, "
88
  " the models you generated, and any other relevant information.\n"
89
+ "4. **Upload your submission**: Upload a **single** `.jsonl` file containing the generated models. "
90
  " **Each line in the file should be a JSON object with two keys: `id` and `model`.**\n"
91
  " * `id`: The ID of the problem exactly as it appears in the original dataset (e.g., `csplib__csplib_001_car_sequencing`).\n"
92
  " * `model`: The generated model for the problem (as a string representing runnable code). Make sure that it eventually outputs the solution as a json with key(s) as described in the `decision_variables` entry and values as would be expected in the problem. This is part of the evaluation as well: unexpected keys, or value types are considered incorrect. This is because our automatic evaluation is based on the solution printed by the submitted models.\n"
93
  " * An example submission file can be found [here](https://huggingface.co/spaces/kostis-init/CP-Bench-competition/blob/main/sample_submission.jsonl).\n"
94
+ "\n To help you get started, we also provide a **template script [here](https://huggingface.co/spaces/kostis-init/CP-Bench-competition/blob/main/template.py)**. This script acts as a backbone, showing how to produce a simple, runnable submission for one of the problems. You can use it as a starting point for developing your own logic.\n"
95
+ "5. **Check the leaderboard**: After uploading, it may take a few minutes for a submission to be evaluated and appear on the leaderboard.\n"
96
  "\n\n"
97
  "## Important Notes\n"
98
  "1. **Submission Name**: The submission name must be different from any existing submission names.\n"
template.py ADDED
@@ -0,0 +1 @@
 
 
1
+ # TODO