Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 7.34 KB

README.md

File metadata and controls

142 lines (104 loc) · 7.34 KB
Raw

Template Challenge

This is a template challenge. If you would like to create a new challenge at Jülich Callenges, please follow the steps. All the steps are necessary.

1) Clone the repository

  • git clone https://github.com/HelmholtzAI-FZJ/juelich_challenges-template-challenge my_challenge
  • cd my_challenge

2) Download Raw data

You first need to download the raw data if needed, it does not matter where you put as long as it is acccessible, for instance yon can put it in the folder raw/ in my_challenge.

3) Build annotation files

You need to create annotation splits. Please check annotations/generate.py for more details. Basically, the script annotations/generate.py should be edited so that it creates annotation files (train.csv, valid.csv, test.csv, submission_valid.csv, submission_test.csv) based on raw data. The splits can be generated randomly or follow the splits you already have in your raw data.

Note that The CSVs should not be heavy, it should not contain images themselves if your challenge have some. If your challenge have images, you can have a column pointing to filenames of the images.

Once you finish editing annotations/generate.py, please run it:

cd annotations;python generate.py

you will have now the following files in the folder annotations/:

  • annotations/train.csv
  • annotations/valid.csv
  • annotations/test.csv
  • annotations/submission_valid.csv
  • annotations/submission_test.csv

4) Edit the evaluation script

This is one of the most important steps because in this step you define the metrics that will be used to rank the participants in the leaderboard.

Please edit evaluation_script/main.py for your challenge. It comes with an example where the accuracy metric is used for a classification problem. But you can use any set of metrics. It is a regular python file, so any metric which can be written in Python could be used. You can use Scikit-Learn which already offers most of the usual metrics. Basically, the script evaluation_script/main.py returns a Python dictionary containing the metric names as keys and the metric values as values. You can use as many metrics as you want, the metric that will be used to rank the participants in the leaderboard will be chosen later in challenge_config.yaml.

Here is just one note about how evaluation_script/main.py works. In order to compute the metrics, the participant submission and the annotation files that you generated previously are opened (e.g., valid.csv or test.csv depending on the challenge phase) in evaluation_script/main.py. The two (participant submission and annotation file) are then compared using the column that corresponds to the label (e.g., the column label in this template challenge).

5) Edit challenge_config.yaml

Please dit challenge_config.yaml and change everything which is specific to your challenge. More documentation about the fields is given at https://evalai.readthedocs.io/en/latest/configuration.html

The most important parts to modify are the fields in the top of the file, they contain basic information about the challenge. Plase also change the leaderboard section. In the leaderboard section, please put all the metric names you want to display in the leaderboard. The metric names correspond to the metric names you defined in evaluation_script/main.py. default_order_by defines the metric you use to rank the participants.

Please check carefully all the fields so that it correspond to your needs for the challenge, such as the starting date and ending date of the different phases and the number of submissions.

6) Edit the template files and the logo

Please edit the HTML files in the folder templates/. These HTML files are displayed in the frontend in your challenge page. Please also modify the logo file logo.jpg to have a custom logo for your challenge, this will displayed in the frontend as well.

7) Edit notebook.ipynb

Please edit notebook.ipynb. This part is important for the participants. This is given to the participants so that they can have the challlenge introduced to them and be able to easily understand the problem and start to submit easily. Steps such as downloading the data, explanation of the problem, exploratory data analysis, baseline solutions, and example submissions should be included.

Here is an example of what it could look like: https://gitlab.version.fz-juelich.de/MLDL_FZJ/juhaicu/jsc_internal/superhaicu/vouchers/j-lich-challenges/challenges/covidx_challenge/-/blob/master/notebook.ipynb

8) Create challenge compressed archives

In order to upload the challenge in the frontend, you need to create the following archives:

  • evaluation_script.zip: contains the contents of the folder evaluation_script
  • challenge_config.zip: contains evaluation_script.zip, the folder annotations/, the file challenge_config.yaml, the folder templates, the logo, and optionally the notebook.

Here is how the archive contents should look like:

Archive:  challenge_config.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
     1292  2020-11-20 14:48   evaluation_script.zip
     2362  2020-11-20 14:48   challenge_config.yaml
   107701  2018-02-26 15:17   logo.png
   473424  2020-09-17 09:59   notebook.ipynb
       49  2020-11-20 14:22   templates/challenge_phase_1_description.html
       26  2020-09-17 11:21   templates/challenge_phase_2_description.html
     5658  2020-11-20 14:22   templates/description.html
       85  2020-09-08 08:55   templates/evaluation_details.html
      244  2020-11-20 14:22   templates/submission_guidelines.html
     1905  2020-11-20 14:22   templates/terms_and_conditions.html
     2572  2020-11-20 14:44   annotations/submission.csv
    16724  2020-09-15 21:55   annotations/submission_test.csv
     2572  2020-09-15 21:55   annotations/submission_valid.csv
     8142  2020-09-15 21:55   annotations/test.csv
    10704  2020-09-15 21:55   annotations/train.csv
     2693  2020-09-15 21:55   annotations/valid.csv
---------                     -------
   636153                     16 files

Please also prepare archives that will be distributed to the participants:

  • data_public_leaderboard_phase.zip. This archive is given to the users for the public leaderboard phase, so you need to upload it somehwere in a public link. This should contain annotations/train.csv (public training data) and annotations/submission_valid.csv (dummy submission for the validation data) and everything that participants need for training (e.g., images for training or validation data)
  • data_private_leaderboard_phase.zip. This archive is given to the users for the private leaderboard phase, so you need to upload it somehwere in a public link. This should contain annotations/valid.csv (public training data) and annotations/submission_test.csv (dummy submission for test data) and everything that participants need for training (e.g., images for training or test data).

Please then upload the data archives in a public link, and point towards the public links in the HTML files in templates/ as well as in the notebook.ipynb

9) Upload challenge_config.zip to the frontend

  • Go to the frontend
  • Click at Create a new challenge, then upload challenge_config.zip.

This is the last step. One of the administrators should then accept your challenge so that it becomes public.

Thanks for following this guide, your challenge should be ready now!