refine readmd

README.md

@@ -1,10 +1,17 @@
 # SUPERB Submission Template
 
-This repository can be used to generate a template so you can submit your pretrained model for evaluation on [the leaderboard](https://huggingface.co/spaces/superb/superb-leaderboard) in the [SUPERB Challenge](https://superbbenchmark.org/challenge).
+Welcome to the [SUPERB Challenge](https://superbbenchmark.org/challenge)! SUPERB is a collection of benchmarking resources to evaluate the capability of a universal shared representation for speech processing. It comes with a benchmark on the publicly available datasets and a challenge on a secret/not released hidden dataset. In SUPERB Challenge, a challenging hidden dataset is newly recorded to evaluate the ultimate generaliziblity across various tasks and data.
+
+You can participate the challenge by simply submitting your self-supervised (SSL) pretrained models (model definition & pretrained weights), and we benchmark it with the hidden dataset. This repository constains useful tools to let you easliy [submit](https://superbbenchmark.org/submit) your models for evaluation to [the challenge leaderboard](https://superbbenchmark.org/leaderboard):
+
+1. Generate a submission template
+2. Validate the format/interface correctness of your model
+3. Upload to Huggingface's Hub
+4. Submit the upload information to [SUPERB website](https://superbbenchmark.org/submit)
 
 ## Quickstart
 
-### 1. Create an account and organisation on the Hugging Face Hub
+### 1. Create an account and organization on the Hugging Face Hub
 
 First create an account on the Hugging Face Hub and you can sign up [here](https://huggingface.co/join) if you haven't already! Next, create a new organization and invite the SUPERB Hidden Set Committee to join. You will upload your model to a repository under this organization so that members inside it can access the model.
 
@@ -75,25 +82,25 @@ That's it! You're now all set to start pretraining your speech models - see the
 
 To make a submission to the [leaderboard](https://superbbenchmark.org/leaderboard), there are 4 main steps:
 
-1. Modify `expert.py` and `model.py` so we can initialize an upstream model following the [policy](https://superbbenchmark.org/challenge) by:
+1. Modify `expert.py` and `model.py` so we can initialize an upstream model following the [challenge policy](https://superbbenchmark.org/challenge) by:
 
     ```python
     upstream = UpstreamExpert(ckpt="./model.pt")
     ```
 
-2. Validate the upstream model meets the requirements in the [policy](https://superbbenchmark.org/challenge). If everything is correct, you should see the following message: "All submission files validated! Now you can make a submission."
+2. Validate the upstream model meets the requirements in the [challenge policy](https://superbbenchmark.org/challenge). If everything is correct, you should see the following message: "All submission files validated! Now you can make a submission."
 
     ```
     python cli.py validate
     ```
 
-3. Push the predictions to the Hub! If there are no errors, you should see the following message: "Upload successful!"
+3. Push the model to the Hub! If there are no errors, you should see the following message: "Upload successful!"
 
     ```
     python cli.py upload "commit message: my best model"
     ```
 
-4. [Make a submission at SUPERB website](https://superbbenchmark.org/submit) by uniquely indentifying this submission/model with the following information, which will be shown by:
+4. [Make a submission at SUPERB website](https://superbbenchmark.org/submit) by uniquely indentifying this uploaded model with the following information, which can be shown by:
 
     ```
     python cli.py info
@@ -103,4 +110,4 @@ To make a submission to the [leaderboard](https://superbbenchmark.org/leaderboar
     - Repository Name
     - Commit Hash (full 40 characters)
 
-After you finish the above 4 steps. Please stay tuned and wait for us to get the finetuned results on the hidden set!
+After you finish the above 4 steps. You will see a new entry in your [SUPERB profile page](https://superbbenchmark.org/profile) (need login) which does not have any benchmark numbers yet. Please wait for us to finetuned it on the hidden dataset and get the benchmark results. The results will later be shown on the entry. Please stay tuned!

{{cookiecutter.repo_name}}/README.md

@@ -1,10 +1,17 @@
 # SUPERB Submission Template
 
-This repository can be used to generate a template so you can submit your pretrained model for evaluation on [the leaderboard](https://huggingface.co/spaces/superb/superb-leaderboard) in the [SUPERB Challenge](https://superbbenchmark.org/challenge).
+Welcome to the [SUPERB Challenge](https://superbbenchmark.org/challenge)! SUPERB is a collection of benchmarking resources to evaluate the capability of a universal shared representation for speech processing. It comes with a benchmark on the publicly available datasets and a challenge on a secret/not released hidden dataset. In SUPERB Challenge, a challenging hidden dataset is newly recorded to evaluate the ultimate generaliziblity across various tasks and data.
+
+You can participate the challenge by simply submitting your self-supervised (SSL) pretrained models (model definition & pretrained weights), and we benchmark it with the hidden dataset. This repository constains useful tools to let you easliy [submit](https://superbbenchmark.org/submit) your models for evaluation to [the challenge leaderboard](https://superbbenchmark.org/leaderboard):
+
+1. Generate a submission template
+2. Validate the format/interface correctness of your model
+3. Upload to Huggingface's Hub
+4. Submit the upload information to [SUPERB website](https://superbbenchmark.org/submit)
 
 ## Quickstart
 
-### 1. Create an account and organisation on the Hugging Face Hub
+### 1. Create an account and organization on the Hugging Face Hub
 
 First create an account on the Hugging Face Hub and you can sign up [here](https://huggingface.co/join) if you haven't already! Next, create a new organization and invite the SUPERB Hidden Set Committee to join. You will upload your model to a repository under this organization so that members inside it can access the model.
 
@@ -75,25 +82,25 @@ That's it! You're now all set to start pretraining your speech models - see the
 
 To make a submission to the [leaderboard](https://superbbenchmark.org/leaderboard), there are 4 main steps:
 
-1. Modify `expert.py` and `model.py` so we can initialize an upstream model following the [policy](https://superbbenchmark.org/challenge) by:
+1. Modify `expert.py` and `model.py` so we can initialize an upstream model following the [challenge policy](https://superbbenchmark.org/challenge) by:
 
     ```python
     upstream = UpstreamExpert(ckpt="./model.pt")
     ```
 
-2. Validate the upstream model meets the requirements in the [policy](https://superbbenchmark.org/challenge). If everything is correct, you should see the following message: "All submission files validated! Now you can make a submission."
+2. Validate the upstream model meets the requirements in the [challenge policy](https://superbbenchmark.org/challenge). If everything is correct, you should see the following message: "All submission files validated! Now you can make a submission."
 
     ```
     python cli.py validate
     ```
 
-3. Push the predictions to the Hub! If there are no errors, you should see the following message: "Upload successful!"
+3. Push the model to the Hub! If there are no errors, you should see the following message: "Upload successful!"
 
     ```
     python cli.py upload "commit message: my best model"
     ```
 
-4. [Make a submission at SUPERB website](https://superbbenchmark.org/submit) by uniquely indentifying this submission/model with the following information, which will be shown by:
+4. [Make a submission at SUPERB website](https://superbbenchmark.org/submit) by uniquely indentifying this uploaded model with the following information, which can be shown by:
 
     ```
     python cli.py info
@@ -103,4 +110,4 @@ To make a submission to the [leaderboard](https://superbbenchmark.org/leaderboar
     - Repository Name
     - Commit Hash (full 40 characters)
 
-After you finish the above 4 steps. Please stay tuned and wait for us to get the finetuned results on the hidden set!
+After you finish the above 4 steps. You will see a new entry in your [SUPERB profile page](https://superbbenchmark.org/profile) (need login) which does not have any benchmark numbers yet. Please wait for us to finetuned it on the hidden dataset and get the benchmark results. The results will later be shown on the entry. Please stay tuned!