zyq00 / cs182_hw3_student

CS182/282 Assignment 3

In this assignment you will implement a neural network to generate news headlines, by training an LSTM-based language model. You will also train a Transformer to summarize news articles.

Setup

Make sure your machine is set up with the assignment dependencies.

[Option 1] Working on Colab (Recommended)

We recommend working on Colab with GPU enabled since this assignment needs a fair amount of compute. In Colab, we can enforce using GPU by clicking Runtime -> Change Runtime Type -> Hardware accelerator and selecting GPU. The dependencies will be installed once the notebooks are excuted.

The Colab version of this assigment can be found at this Drive link, please logining with you Berkeley email to view it. You should make a copy of the folder to your Google Drive otherwise the outputs will not be saved. Once the folder is copied, you can start working by clicking a Jupyter Notebook and openning it in Colab.

[Option 2] Install Anaconda and Required Packages (Slow)

The preferred approach for installing all the assignment dependencies is to use Anaconda, which is a Python distribution that includes many of the most popular Python packages for science, math, engineering and data analysis. Once you install Anaconda you can run the following command inside the homework directory to install the required packages for this homework:

conda env create -f cs182_hw3.yml

Once you have all the packages installed, run the following command every time to activate the environment when you work on the homework.

conda activate cs182_hw3

If you have access to GPU then you can uninstall cpu version and install cuda version PyTorch.

conda uninstall cpuonly pytorch
conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch

If you are on macos, run the following command to install wget and md5sha1sum.

brew install md5sha1sum wget

[Option 3] Working on a Virtual Machine (Slow)

This assignment is provided pre-setup with a VirtualBox image. Installation Instructions:

1. Follow the instructions here to install VirtualBox if it is not already installed.
2. Download the VirtualBox image here
3. Load the VirtualBox image using the instructions here
4. Start the VM. The username and password are both cs182. Required packages are pre-installed and the cs182_hw3 environment activated by default.
5. Download the assignment code onto the VM yourself.

FAQ

I get an error "AMD-V is disabled in the BIOS" or "Intel-VT is disabled in the BIOS" or similar

Solution: See this link

The virtual machine won't boot

Solutions:

• Try increasing the number of allocated CPUs: Under Settings→System→Processor
• Try increasing the amount of allocated memory:

Download data (For option 2 and 3):

To download the data, run the following command from the assignment root directory:

bash download_data.sh

If you get the error "bash: ./download_data.sh: Permission denied" run chmod +x download_data.sh and try again.

Start Jupyter Notebook (For option 2 and 3)

After you download data, you should start the IPython notebook server from the homework 1 directory with the following command:

jupyter notebook

Submitting your work:

Once you are done working, run the collect_submission.ipynb notebook if you worked on Colab; this will produce a file called assignment3.zip and download it to your computer from Colab.

If you worked locally, then run the collect_submission.sh script; this will produce a file called assignment3.zip.

Check that your submission contains:

• "1 Language Modeling.ipynb" and "2 Summarization.ipynb"
• "transformer.py", "transformer_attention.py", "language_model.py"
• Your folder for best models for each notebook, best_models
• Your folder for submission logs, submission_logs

Upload this file to Gradescope. The Gradescope will run an autograder on the files you submit. It is very unlikely but still possible that your implementation might fail to pass some test cases due to randomness. If you think your code is correct, you can simply rerun the autograder to check check whether it is really due to randomness.

Q1: LSTM for Language Modeling (40 points)

The IPython notebook Language Modeling.ipynb will introduce you to the implementation of preprocessing raw text and training an LSTM. Follow the instructions in the notebook to complete this part.

Q2: Transformer Network for Summarization (60 points)

The IPython notebook Summarization.ipynb will introduce you to the implementation of Transformer to summarize news articles. Follow the instructions in the notebook to complete this part.