Difference between revisions of "Contest Data Package"

From PC2wiki
Jump to: navigation, search
m (Examples: added examples)
m (Multiple Sites: more info)
Line 168: Line 168:
 
results.tsv and scoreboard.tsv (scoreboards).
 
results.tsv and scoreboard.tsv (scoreboards).
  
The site 1 information is stored under the cdp as described,
+
# The site 1 information is stored under the cdp as described (no need for site1 directories)
any site is stored under siteN where N is the number of
+
# Other sites are stored under their respective site dirs under the same cdp directory with the site name (see examples)
the site.  No zero padding is allowed for the other site
+
# Each site is stored under siteN where N is the number of the site.   
directory or filenames.
+
# No zero padding is allowed for the site directory or filenames.
  
 
Examples
 
Examples

Revision as of 08:17, 25 November 2014

A contest data package (CDP) is a description of files/directories that are input and output from a contest.

Introduction

This standard contains a description of the organization of contest data. Both the data that is input to the contest and the results of the contest.

Here are two example of the standard.

To learn how pc2 imports and exports the data see the Import/Export section below.

Sample One

config/hello/problem.yaml
config/hello/data/secret/hello.ans
config/hello/data/secret/hello.in
config/hello/data/problem_statement/problem.tex
config/teams.tsv
config/sumit/problem.yaml
config/sumit/data/secret/sumit.in
config/sumit/data/secret/sumit.ans
config/sumit/data/problem_statement/problem.tex
config/contest.yaml
config/problemset.yaml
config/groups.tsv
config/userdata.tsv

submissions/1/A.java
submissions/3/C.java
submissions/3/A.java
submissions/2/A.java

results/runs.tsv
results/scoreboard.tsv
results/standings.json
results/results.tsv
backups/team1.tar.gz
backups/team2.tar.gz
backups/team3.tar.gz
video/reactions/reaction3.m2ts
video/reactions/reaction1.m2ts
video/reactions/reaction2.m2ts
images/teams/team3.jpg
images/teams/team2.jpg
images/teams/team1.jpg
images/logos/logo1.png
images/logos/logo3.png
images/logos/logo2.png

eventFeed/eventfeed.json
eventFeed/eventfeed.xml

Sample Two

backups/team1.tar.gz
backups/team2.tar.gz
backups/team3.tar.gz
config/contest.yaml
config/groups.tsv
config/problemset.yaml
config/teams.tsv
config/userdata.tsv
config/hello/problem.yaml
config/hello/data/problem_statement/problem.tex
config/hello/data/secret/hello.ans
config/hello/data/secret/hello.in
config/sumit/data/problem_statement/problem.tex
config/sumit/data/secret/sumit.ans
config/sumit/data/secret/sumit.in
config/sumit/problem.yaml
eventFeed/events.json
eventFeed/events.xml
images/logos/logo1.png
images/logos/logo2.png
images/logos/logo3.png
images/teams/team1.jpg
images/teams/team2.jpg
images/teams/team3.jpg
results/results.tsv
results/runs.tsv
results/scoreboard.tsv
results/standings.json
submissions/1/run.properties
submissions/1/A.java
submissions/2/A.java
submissions/2/run.properties
submissions/3/run.properties
submissions/3/A.java
submissions/3/C.java
video/reactions/reaction1.m2ts
video/reactions/reaction2.m2ts
video/reactions/reaction3.m2ts

Layout / Structure

Input Files

These are files that are input/configuration files for a contest.

config directory

Contains configuration (input) files to configure a CCS (pc2).

images/logos directory

  • contains 600x600 images of each team's logo, in logo<x>.png format.

images/teams directory

  • contains 1920x1080 images of each team, in team<x>.jpg format.

Output Files

These are files that are output from a contest.

submissions directory

  • contains a folder for each run submission

submissions/## directory

  1. Team's submitted source code file(s)
  2. run.properties file (optional)

eventFeed directory

  1. Finalized event feed events.xml
  2. events.json

- may contain other files in the format "<x>-events.xml", e.g. "pc2-events.xml".

results directory

  • contains other output files from the CCS.
  1. results.tsv
  2. scoreboard.tsv

results/<CCS> directory

  • contain CCS specific results files, ex. reports, ex
results/pc2/results.tsv
results/pc2/scoreboard.tsv

video/reactions directory

  • contains recorded reaction videos for each submission, in reaction<X>.m2ts format.

backups directory

  • contains a final backups of each team's working folder in the form team<X>.tar.gz.

Multiple Sites

The CDP was developed for the ICPC Finals and single site contests. This section covers where to put other sites' files.

In general each sites' data is saved in a directory under the cdp directory.

Certain output files contain all sites' information like results.tsv and scoreboard.tsv (scoreboards).

  1. The site 1 information is stored under the cdp as described (no need for site1 directories)
  2. Other sites are stored under their respective site dirs under the same cdp directory with the site name (see examples)
  3. Each site is stored under siteN where N is the number of the site.
  4. No zero padding is allowed for the site directory or filenames.

Examples

site3
site4
site9
site22

Examples

These example location and files will be for site 4 of a contest.

results/site4

Here would be the locations for files for site4 data.

backups/site4/team1.tar.gz
backups/site4/team2.tar.gz
backups/site4/team3.tar.gz
eventFeed/site4/events.json
eventFeed/site4/events.xml
images/site4/logos/logo1.png
images/site4/logos/logo2.png
images/site4/logos/logo3.png
images/site4/teams/team1.jpg
images/site4/teams/team2.jpg
images/site4/teams/team3.jpg
results/site4/results.tsv
results/site4/runs.tsv
results/site4/scoreboard.tsv
results/site4/standings.json
submissions/site4/1/A.java
submissions/site4/1/run.properties
submissions/site4/2/A.java
submissions/site4/2/run.properties
submissions/site4/3/A.java
submissions/site4/3/C.java
submissions/site4/3/run.properties
video/reactions/site4/reaction1.m2ts
video/reactions/site4/reaction2.m2ts
video/reactions/site4/reaction3.m2ts

PC² Import/Export

For each file or set of files, click on the link to learn how to import / export from PC². The articles also describe the contents of the files.

Notes

To start/configure a contest the only required folder is config/. A contest archive with only config/ is only useful for loading into a CCS to start configuring a contest.

Once the contest is complete, the final event feed and submission files should be added back into the archive.

Other content is added as available, e.g. some contests will have backups, reaction videos, or logos, and others won't.

See Also