Create README.md

README.md

@@ -0,0 +1,40 @@
+# **HW2**
+
+## **Environment**
+```
+pip install -r requirements.txt
+```
+
+## **Download**
+Download training and validation data, as well as fine-tuned mT5 model.
+```
+bash ./download.sh
+```
+
+## **Fine tuning mT5 model**
+```
+python ./code/run_summarization.py \
+    --model_name_or_path google/mt5-small \
+    --train_file train.jsonl \
+    --validation_file public.jsonl \
+    --dataset_config "3.0.0" \
+    --source_prefix "summarize: " \
+    --output_dir ./HW2 \
+    --num_train_epochs 3 \
+    --num_beams 1 \
+    --do_sample False \
+    --push_to_hub
+```
+-**model_name_or_path**: Path to pretrained model.
+
+-**output_dir**: Path to directory which saves the model outputs.
+
+-**train_file**: Path to train.jsonl.
+
+-**validation_file**: Path to public.jsonl.
+
+## **Generate output.jsonl**
+```
+bash ./download.sh
+bash ./run.sh /path/to/input.jsonl /path/to/output.jsonl
+```