SUBMISSION_DESC.md

# Submission

## Submission Instruction

Please refer to [challenge README](https://github.com/OpenDriveLab/DriveLM/blob/main/challenge/README.md) on Github to prepare data and train your model. Please evaluate your [output.json](https://github.com/OpenDriveLab/DriveLM/blob/main/challenge/output.json) locally first before submitting to test server.

1. Prepare your result

    Open [prepare_submission.py](https://github.com/OpenDriveLab/DriveLM/blob/main/challenge/prepare_submission.py) and fill in the following information starting line 4:
    ```
    method = ""  # <str> -- name of the method
    team = ""  # <str> -- name of the team, !!!identical to the Google Form!!!
    authors = [""]  # <list> -- list of str, authors
    email = ""  # <str> -- e-mail address
    institution = ""  # <str> -- institution or company
    country = ""  # <str> -- country or region
    ```
    While other fields can change between different submissions, make sure you <font color=red> always use your team name submitted on Google registration form for the `team` field, NOT the anonymous team name to be shown on the leaderboard</font>.
    Then run this file:
    ```bash
    # make sure you are under ./challenge
    python prepare_submission.py
    ```
    This will generate `submission.json` with your information and result. An [example](https://github.com/OpenDriveLab/DriveLM/blob/main/challenge/submission.json) is given in this folder. 

2. Upload your result as **a Hugging Face model**

    Click your profile picture on the top right of the Hugging Face website, and select `+ New Model`. Create a new model repository, and upload the `submission.json` file.
    
    Note that private models are also acceptable by the competition space.

3. Submit your result and evaluate on test server

    Click `New Submission` on the left panel of the competition space. Paste the link of the Hugging Face model you created under `Hub model`. Then click `Submit`. 

    <font color=red> Note: you can make up to 3 submissions per day. </font>


## FAQ

### How to View My Submissions?

You can check the status of your submissions in the `My submissions` tab of the competition space.

Please refer to [these slides](https://docs.google.com/presentation/d/1bicxoR_L3t05p5xw-qZM0Dj5KdJhjynqLM0Rck0qdcI/edit?usp=sharing) for explaination of each score.

You can select a submission and click `Update Selected Submissions` on the bottom to update its evaluation status to the private leaderboard. Please note that <font color=red>public score and private score are exactly the same</font> in our case. So please ignore the descriptions in `My Submissions` tab. 

### The `New Submission` page shows `Invalid Token` when I click `Submit`, what should I do?

This means you are no longer logged in to the current competition space, or the space has automatically logged you out due to inactivity (more than a day). 

Please refresh the page, click `Login with Hugging Face` at the bottom of the left panel, and resubmit.

### Can I Submit Without Making My Submission Public?

Of course. The competition space accepts Hugging Face private models. In fact, we recommend participants to submit as private models to keep their submissions private.

### Will My Evaluation Status Be Visible to Others?

The public leaderboard will be open with the best results of all teams about a week before the competition ends.

**Note that** you can change your team name even after the competition ends. Thus, if you want to stay anonymous on the public leaderboard, you can first use a temporary team name and change it to your real team name after the competition ends.

### My evaluation status shows `Failed`, how can I get the error message?

First, make sure your submission is in the correct format as in [submission preparation](#submission-preparation) and you upload the correct Hugging Face **model** link (in the format of `Username/model`) in `New Submission`.

The error message is listed under `Submission Comment` column under `My Submissions` tab.

### I could not visit `My Submissions` page, what should I do?

Chances are that you are not logged in to the current competition space. 

Please refresh the page, click `Login with Hugging Face` at the bottom of the left panel.

### If I encounter a reshape error, what should I do?

You should first refer to this [location](https://github.com/OpenDriveLab/DriveLM/blob/main/challenge/evaluation.py#L89). Most of the reshape errors occur here.


### Finally, which dataset do we submit to the competition?

Please refrain from using demo data. Instead, utilize the [validation data](https://drive.google.com/file/d/1fsVP7jOpvChcpoXVdypaZ4HREX1gA7As/view?usp=sharing) for inference and submission to the evaluation server.

### I encountered KeyError: 'b789de07180846cc972118ee6d1fb027_b0e6fd5561454b2789c853e5350557a8_0' in my Submission Comment, what should I do?
If you saw a random UUID in Submission Comment, the error happens on [this line](https://github.com/OpenDriveLab/DriveLM/blob/030265cb243dd5b88bd0e20130c1a72e68bcf14e/challenge/evaluation.py#L178), you can try to reproduce this error locally. Most likely, this is due to not using the validation data we mentioned above.

### My submission is stuck at `Processing`, what should I do?
This is likely due to server error on Hugging Face side, please wait for a while and submit again. If this error persists, contact our challenge host below.

### My error information is not listed here, what should I do?
If you confirm that the submission format is correct, please contact the challenge host [Chonghao Sima](mailto:simachonghao@pjlab.org.cn) via email. Please include the **Submission ID** of the corresponding submission in the email. The Submission ID can be found in the `My Submissions` tab.

```
Email Subject:
[OFFICIAL DRIVELM] Failed submission - {Submission ID}
Body:
  Your Name: {}
  Team Name: {}
  Institution / Company: {}
  Email: {}
```