From 8245b92b59e7d3f01074935e228cfdc4b5cd9eed Mon Sep 17 00:00:00 2001 From: Priya Kasimbeg Date: Tue, 26 Mar 2024 23:32:22 +0000 Subject: [PATCH 1/3] clarifications --- GETTING_STARTED.md | 4 ++-- README.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 3ae809a47..006b972ec 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -391,7 +391,7 @@ We provide the scores and performance profiles for the [paper baseline algorithm ## Package your Submission code If you have registered for the AlgoPerf competition you will receive -an email with a link to a UI to upload a compressed submission folder. +an email on 3/27/2024 with a link to a UI to upload a compressed submission folder. To package your submission modules please make sure your submission folder is structured as follows: @@ -417,7 +417,7 @@ Specifically we require that: 1. There exist subdirectories in the the submission folder named after the ruleset: `external_tuning` or `self_tuning`. 2. The ruleset subdirectories contain directories named according to some identifier of the algorithm. -3. Each algorithm subdirectory contains a `submission.py` module. Additional helper modules are allowed. If there are additional python packages that have to be installed for the algorithm also include the `requirements.txt` in the algorithm subdirectory. +3. Each algorithm subdirectory contains a `submission.py` module. Additional helper modules are allowed if prefer to you organize your code into multiple files. If there are additional python packages that have to be installed for the algorithm also include a `requirements.txt` with package names and versions in the algorithm subdirectory. 4. For `external_tuning` algorithms the algorithm subdirectory should contain a `tuning_search_space.json`. diff --git a/README.md b/README.md index 04052b4e9..0b5129d54 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,9 @@ > [!IMPORTANT] > Upcoming Deadline: -> Submission deadline: **April 04th, 2024** (*moved by a week*) \ -> For other key dates please see [Call for Submissions](/CALL_FOR_SUBMISSIONS.md). +> Submission deadline: **April 04th, 2024** (*moved by a week*). \ +> For submission instructions please see [GETTING_STARTED.md](/GETTING_STARTED.md#package-your-submission-code).\ +> For other key dates please see [Call for Submissions](CALL_FOR_SUBMISSIONS.md). ## Table of Contents From 665768779c74534aad5d83047e143c55867dac64 Mon Sep 17 00:00:00 2001 From: Priya Kasimbeg Date: Tue, 26 Mar 2024 23:34:09 +0000 Subject: [PATCH 2/3] clarifications --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b5129d54..933969d18 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ > [!IMPORTANT] > Upcoming Deadline: > Submission deadline: **April 04th, 2024** (*moved by a week*). \ -> For submission instructions please see [GETTING_STARTED.md](/GETTING_STARTED.md#package-your-submission-code).\ +> For submission instructions please see [Getting Started](/GETTING_STARTED.md#package-your-submission-code) document.\ > For other key dates please see [Call for Submissions](CALL_FOR_SUBMISSIONS.md). ## Table of Contents From 45921dd2773320d01cc4ce94bb3678827b4346c9 Mon Sep 17 00:00:00 2001 From: Priya Kasimbeg Date: Tue, 26 Mar 2024 23:35:05 +0000 Subject: [PATCH 3/3] clarifications --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 933969d18..3628caede 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ > [!IMPORTANT] > Upcoming Deadline: > Submission deadline: **April 04th, 2024** (*moved by a week*). \ -> For submission instructions please see [Getting Started](/GETTING_STARTED.md#package-your-submission-code) document.\ +> For submission instructions please see [Packaging your Submission Code](/GETTING_STARTED.md#package-your-submission-code) section in the Getting Started document.\ > For other key dates please see [Call for Submissions](CALL_FOR_SUBMISSIONS.md). ## Table of Contents