|
--- |
|
benchmark: raft |
|
type: prediction |
|
--- |
|
|
|
# RAFT submissions for {{cookiecutter.repo_name}} |
|
|
|
## Submitting to the leaderboard |
|
|
|
To make a submission to the [leaderboard](https://huggingface.co/spaces/ought/raft-leaderboard), there are three main steps: |
|
|
|
1. Generate predictions on the unlabeled test set of each task |
|
2. Validate the predictions are compatible with the evaluation framework |
|
3. Push the predictions to the Hub! |
|
|
|
See the instructions below for more details. |
|
|
|
### Rules |
|
|
|
1. To prevent overfitting to the public leaderboard, we only evaluate **one submission per week**. You can push predictions to the Hub as many times as you wish, but we will only evaluate the most recent commit in a given week. |
|
2. Transfer or meta-learning using other datasets, including further pre-training on other corpora, is allowed. |
|
3. Use of unlabeled test data is allowed, as is it always available in the applied setting. For example, further pre-training using the unlabeled data for a task would be permitted. |
|
4. Systems may be augmented with information retrieved from the internet, e.g. via automated web searches. |
|
|
|
### Submission file format |
|
|
|
For each task in RAFT, you should create a CSV file called `predictions.csv` with your model's predictions on the unlabeled test set. Each file should have exactly 2 columns: |
|
|
|
* ID (int) |
|
* Label (string) |
|
|
|
See the dummy predictions in the `data` folder for examples with the expected format. Each `predictions.csv` file should be stored in the task's subfolder in `data` and at the end you should have something like the following: |
|
|
|
``` |
|
data |
|
βββ ade_corpus_v2 |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ banking_77 |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ neurips_impact_statement_risks |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ one_stop_english |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ overruling |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ semiconductor_org_types |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ systematic_review_inclusion |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ tai_safety_research |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ terms_of_service |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ tweet_eval_hate |
|
β βββ predictions.csv |
|
β βββ task.json |
|
βββ twitter_complaints |
|
βββ predictions.csv |
|
βββ task.json |
|
``` |
|
|
|
### Validate your submission |
|
|
|
To ensure that your submission files are correctly formatted, run the following command from the root of the repository: |
|
|
|
``` |
|
python cli.py validate |
|
``` |
|
|
|
If everything is correct, you should see the following message: |
|
|
|
``` |
|
All submission files validated! β¨ π β¨ |
|
Now you can make a submission π€ |
|
``` |
|
|
|
### Push your submission to the Hugging Face Hub! |
|
|
|
The final step is to commit your files and push them to the Hub: |
|
|
|
```bash |
|
git add . |
|
git commit -m "Some commit message" |
|
git push -f origin HEAD:main |
|
``` |