Update utils.py (#74)

- Update utils.py (7db36fb951fab07d2dc0ce8d3453637b4e30f390)
- update instructions (9ab81b0bd320d5051ab82e012eaa7135fa3c3eb2)
- update submission instructions to reduce confusion (4e303daeb37f7d8b1e5538f87715daf6d5041a61)


Co-authored-by: MINGYI SU <MINGYISU@users.noreply.huggingface.co>

utils.py

@@ -65,11 +65,14 @@ CITATION_BUTTON_TEXT = r"""@article{jiang2024vlm2vec,
   year={2024}
 }"""
 
-SUBMIT_INTRODUCTION = """# Submit on MMEB Leaderboard Introduction
-
-## Please refer to the [**GitHub page**](https://github.com/TIGER-AI-Lab/VLM2Vec) for detailed instructions about evaluating your model. \n
-## After running the pipelines, please use the script we provided \(e.g., [report_score_v2.py](https://github.com/TIGER-AI-Lab/VLM2Vec/blob/main/experiments/report_score_v2.py)\) to generate the unified score sheet which is like the following format. 
-## ⚠️ Please note that you need to submit the JSON file with the following format:
+SUBMIT_INTRODUCTION = """# Submit on MMEB Leaderboard Introduction \n
+# <span style="color:#FFA500; font-weight:bold;">We have provided detailed step-by-step guides on how to submit your model. Please read carefully in order to submit successfully.</span> \n
+1. **Step  1️⃣:** Please refer to the [**GitHub page**](https://github.com/TIGER-AI-Lab/VLM2Vec) for detailed instructions about evaluating your model. \n
+2. **Step  2️⃣:** After running the evaluation pipelines, please use the script we provided \(e.g., [report_score_v2.py](https://github.com/TIGER-AI-Lab/VLM2Vec/blob/main/experiments/report_score_v2.py)\) to generate the unified score sheet. 
+    - Reminder: Don't forget to adjust your model's configurations in the script, including model name, URL, model size, and data source.
+        - Note that the "model size" field is by default in Billions (B), and only digits are allowed, so please convert it accordingly if your model size is in different units (e.x., "8" for 8 billion, "0.5" for 500 million, don't include non-digits in it).
+    - Note: Please double check that your score sheet should look like the following format ⬇️: \n
+    - (⚠️ There are remaining steps to be continued after this code block) \n
 ```json
 {
     "metadata": {
@@ -91,35 +94,24 @@ SUBMIT_INTRODUCTION = """# Submit on MMEB Leaderboard Introduction
             }, 
             ... ...
         }, 
-        "visdoc": {
-            "ViDoRe": {
-                "hit@1": 0.5,
-                "ndcg@1": 0.5,
-                ... ...
-            }, 
-            ... ...
-        },
         "video": {
-            "DiDeMo": {
-                "hit@1": 0.5,
-                "ndcg@1": 0.5,
-                ... ...
-            }, 
-            "MSR-VTT": {
-                ... ...
-            }, 
             ... ...
-        }
+        },
+        ... ...
     }
 }
 ```
-## ⚠️ To submit, create a pull request and upload the generated JSON file to the ***scores*** folder, then inform us on [our discord server](https://discord.gg/njyKubdtry), or send us an email at m7su@uwaterloo.ca, including your model's information.\n
-Please email us or leave a simple message (simply @ us) in the PR to indicate that you are ready to merge your PR. We will not merge your PR without informing us since we might think you are still editing and not yet ready to merge. 
-We will review your submission and update the leaderboard accordingly. \n\n
-## Special Instructions for submitting to MMEB Image (Previously MMEB-V1) Leaderboard
-We understand that some researchers want to exclusively submit to the Image leaderboard, but unfortunately our current code doesn't support that. To do so, simply run the 36 image datasets only and ignore the other datasets. 
+3. **Step  3️⃣:** Finally, create a pull request and upload the generated JSON file to the ***scores*** folder. 
+    - You can directly use the Hugging Face Space's web UI to upload your files:
+        - Go to the [scores folder](https://huggingface.co/spaces/TIGER-Lab/MMEB-Leaderboard/upload/main/scores)
+        - Select "Upload file" and upload your JSON files.
+    - Please inform us on [our discord server](https://discord.gg/njyKubdtry), or send us an email at m7su@uwaterloo.ca, or leave a simple message (simply @ us) in the PR to indicate that you are ready to merge your PR. 
+    - We will then review your submission and update the leaderboard accordingly. \n\n
+## ⚠️ Special Instructions for submitting to MMEB Image (Previously MMEB-V1) Leaderboard
+We understand that some researchers want to exclusively submit to the Image leaderboard, but unfortunately our current leaderboard system cannot exclude your model from other modalities' leaderboards. 
+To do so, please run the 36 image datasets only and simply ignore the other datasets.
 The leaderboard will automatically assign a 0 to the missing datasets. 
-We might be able to hide your model from the other leaderboards in the next leaderboard updates, but for now your model will be shown on all leaderboards and might have a lower rank. 
+We might be able to hide your model from the other leaderboards in the next leaderboard updates, but for now your model will be shown on all leaderboards and might have a lower rank. \n
 We highly recommend joining our [discord server](https://discord.gg/njyKubdtry), which provides a convenient way to stay informed with latest updates, or share any feedback you have for improving the leaderboard experience. We appreciate your contributions to the MMEB community!
 """