Explain submission format

app.py

@@ -49,14 +49,40 @@ def http_post(
 with st.form(key="form"):
     # Flush local repo
     shutil.rmtree(LOCAL_REPO, ignore_errors=True)
-    uploaded_file = st.file_uploader("Upload a submission.json file", type=["json"])
+    uploaded_file = st.file_uploader("Upload submission.json file", type=["json"])
 
     if uploaded_file is not None:
         data = str(uploaded_file.read(), "utf-8")
         json_data = json.loads(data)
 
-    with st.expander("Example submission"):
-        with open("submission.json", "r") as f:
+    with st.expander("Submission format"):
+        st.markdown(
+            """
+        Please follow this JSON format for your `submission.json` file:
+
+        ```json
+        {
+        "submission_name": "An identifying name of your system",
+        "param_count": 123, # The number of parameters your system has.
+        "description": "An optional brief description of the system that will be shown on the results page",
+        "tasks":
+            {
+            "dataset_identifier": {
+                "values": ["output1", "output2", "..."], # A list of system outputs.
+                # Optionally, you can add the keys which are part of an example to ensure that there is no shuffling mistakes.
+                "keys": ["key-0", "key-1", ...]
+                }
+            }
+        }
+        ```
+        In this case, `dataset_identifier` is the identifier of the dataset
+        followed by an identifier of the set the outputs were created from, for
+        example `_validation` or `_test`. For example, the `mlsum_de` test set
+        would have the identifier `mlsum_de_test`. the Please see the sample
+        submission below:
+        """
+        )
+        with open("sample-submission.json", "r") as f:
             example_submission = json.load(f)
             st.json(example_submission)
 
@@ -66,7 +92,7 @@ with st.form(key="form"):
         help="You can generate an access token via your Hub settings. See the [docs](https://huggingface.co/docs/hub/security#user-access-tokens) for more details",
     )
 
-    submit_button = st.form_submit_button("Submit")
+    submit_button = st.form_submit_button("Make Submission")
 
 if submit_button:
     validate_submission(json_data)

submission.json → sample-submission.json

@@ -1,7 +1,7 @@
 {
     "submission_name": "T5-base",
     "param_count": 222903552,
-    "description": "",
+    "description": "Sample submission with model predictions across multiple datasets",
     "tasks": {
         "mlsum_de_test": {
             "values": [
@@ -34,38 +34,6 @@
                 "mlsum_de-challenge_test_covid-0",
                 "mlsum_de-challenge_test_covid-1"
             ]
-        },
-        "mlsum_es_test": {
-            "values": [
-                "El PSOE y el PNV aprovechan la moción de censura que convirtió a Sánchez en presidente del Gobierno",
-                "El desfile de las Fuerzas Armadas estará presidido por los Reyes de Espa ⁇ a"
-            ],
-            "keys": [
-                "mlsum_es-test-0",
-                "mlsum_es-test-1"
-            ]
-        },
-        "mlsum_es_challenge_train_sample": {
-            "values": [
-                "La red gaditana de Gibraltar emplea 60.000 euros por alijo para cobrar un lanchero de las organizaciones del narcotráfico",
-                "La Junta de Andaluc ⁇ a encarga el Centro de Estudios y Experimentación en Obras P ⁇ blicas para analizar la capacidad máxima del r ⁇ o"
-            ]
-        },
-        "mlsum_es_challenge_validation_sample": {
-            "values": [
-                "Un nuevo estudio retrasa el horario de la primera clase de la jornada y el aumento de las calificaciones fue del 4,5%",
-                "La hija de una toledana, Laura Sanz Nombela, acaecida en una panader ⁇ a, se encuentran en el hospital de la capital francesa"
-            ]
-        },
-        "mlsum_es_challenge_test_covid": {
-            "values": [
-                "El 75% de los pacientes en lista de espera quir ⁇ rgica en grandes hospitales esperan intervenirse y pidiendo un aplazamiento",
-                "La empresa Viralgen, que apuesta por el coronavirus, apuesta por el ant ⁇ geno para proteger frente al coronavirus"
-            ],
-            "keys": [
-                "mlsum_es-challenge_test_covid-0",
-                "mlsum_es-challenge_test_covid-1"
-            ]
         }
     }
 }