NLP 2023: Homework #3

This is the third homework of the NLP 2023 course at Sapienza University of Rome.

Instructor

• Roberto Navigli
  • Webpage: http://www.diag.uniroma1.it/~navigli/

Teaching Assistants

• Edoardo Barba
• Tommaso Bonomo
• Karim Ghonim
• Giuliano Martinelli
• Francesco Molfese
• Stefano Perrella
• Lorenzo Proietti

Course Info

• http://naviglinlp.blogspot.com/

Requirements

• Ubuntu distribution
  • Either 20.04 or the current LTS (22.04) are perfectly fine.
  • If you do not have it installed, please use a virtual machine (or install it as your secondary OS). Plenty of tutorials online for this part.
• Conda, a package and environment management system particularly used for Python in the ML community.

Notes

Unless otherwise stated, all commands here are expected to be run from the root directory of this project.

Setup Environment

To evaluate your submissions we will be using Docker to remove any issue pertaining your code runnability. If test.sh runs on your machine (and you do not edit any uneditable file), it will run on ours as well; we cannot stress enough this point.

Please note that, if it turns out it does not run on our side, and yet you claim it run on yours, the only explanation would be that you edited restricted files, messing up with the environment reproducibility: regardless of whether or not your code actually runs on your machine, if it does not run on ours, you will be failed automatically. Only edit the allowed files.

To run test.sh, we need to perform two additional steps:

• Install Docker
• Setup a client

For those interested, test.sh essentially setups a server exposing your model through a REST API and then queries this server, evaluating your model.

Install Docker

curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh
rm get-docker.sh
sudo usermod -aG docker $USER

Unfortunately, for the latter command to have effect, you need to logout and re-login. Do it before proceeding. For those who might be unsure what logout means, simply reboot your Ubuntu OS.

Setup Client

Your model will be exposed through a REST server. In order to call it, we need a client. The client has already been written (the evaluation script) but it needs some dependencies to run. We will be using conda to create the environment for this client.

conda create -n nlp2023-hw3 python=3.9
conda activate nlp2023-hw3
pip install -r requirements.txt

Run

test.sh is a simple bash script. To run it:

conda activate nlp2023-hw3
bash test.sh data/test.jsonl

Actually, you can replace data/test.jsonl to point to a different file, as far as the target file has the same format.

If you hadn't changed hw3/stud/model.py yet when you run test.sh, the scores you just saw describe how a baseline that always returns the same prediction for each sentence behaves. To have test.sh evaluate your model, follow the instructions in the slide.