Merge pull request #611 from OptimalScale/rpan-improve-finetune-scripts

Improve interface of finetuning scripts
OptimalScale · Aug 9, 2023 · 46e7582 · 46e7582
2 parents 463785a + 6551f8f
commit 46e7582
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ Our package has been fully tested on Linux OS (Ubuntu 20.04). Other OS platforms
 You may encounter some unexpected errors. You may try it first on a Linux machine or use Google Colab to experience it.
 
 ```bash
-git clone -b v0.0.4 https://github.com/OptimalScale/LMFlow.git
+git clone -b v0.0.5 https://github.com/OptimalScale/LMFlow.git
 cd LMFlow
 conda create -n lmflow python=3.9 -y
 conda activate lmflow
@@ -101,19 +101,36 @@ Please refer to our [doc](https://optimalscale.github.io/LMFlow/examples/DATASET
 Full training updates all the parameters to finetune a language model.
 Here is an example to finetune a GPT-2 base model
 ```sh
-./scripts/run_finetune.sh
+cd data && ./download.sh alpaca && cd -
+
+./scripts/run_finetune.sh \
+  --model_name_or_path gpt2 \
+  --dataset_path data/alpaca/train \
+  --output_model_path output_models/finetuned_gpt2
 ```
 
 ### Finetuning (LoRA)
 LoRA is a parameter-efficient finetuning algorithm and is more efficient than full finetuning.
 ```sh
-./scripts/run_finetune_with_lora.sh
+cd data && ./download.sh alpaca && cd -
+
+# Saves lora only
+./scripts/run_finetune_with_lora.sh \
+  --model_name_or_path facebook/galactica-1.3b \
+  --dataset_path data/alpaca/train \
+  --output_lora_path output_models/finetuned_galactica_lora
+
+# Saves lora and merges into original model
+./scripts/run_finetune_with_lora_save_aggregated_weights.sh \
+  --model_name_or_path facebook/galactica-1.3b \
+  --dataset_path data/alpaca/train \
+  --output_model_path output_models/finetuned_galactica
 ```
 
 ### Inference
 After finetuning, you can run the following command to chat with the model.
 ```sh
-./scripts/run_chatbot.sh {finetuned-checkpoints-path}
+./scripts/run_chatbot.sh output_models/finetuned_gpt2
 ```
 
 ### Deployment

diff --git a/scripts/run_finetune.sh b/scripts/run_finetune.sh
@@ -3,26 +3,47 @@
 #   https://github.com/shizhediao/llm-ft
 #     COMMIT: d5fecf30ba8011067b10cf51fede53a5ab6574e4
 
-deepspeed_args="--master_port=11000"      # Default argument
-if [ $# -ge 1 ]; then
-  deepspeed_args="$1"
-fi
+# Parses arguments
+model_name_or_path=gpt2
+dataset_path=data/alpaca/train
+output_dir=output_models/finetune
+deepspeed_args="--master_port=11000"
 
+while [[ $# -ge 1 ]]; do
+  key="$1"
+  case ${key} in
+    -m|--model_name_or_path)
+      model_name_or_path="$2"
+      shift
+      ;;
+    -d|--dataset_path)
+      dataset_path="$2"
+      shift
+      ;;
+    -o|--output_model_path)
+      output_dir="$2"
+      shift
+      ;;
+    --deepspeed_args)
+      deepspeed_args="$2"
+      shift
+      ;;
+    *)
+      echo "error: unknown option \"${key}\"" 1>&2
+      exit 1
+  esac
+  shift
+done
+
+# Finetune
 exp_id=finetune
 project_dir=$(cd "$(dirname $0)"/..; pwd)
-output_dir=${project_dir}/output_models/${exp_id}
 log_dir=${project_dir}/log/${exp_id}
-
-dataset_path=${project_dir}/data/alpaca/train
-if [ ! -d ${dataset_path} ]; then
-  cd data && ./download.sh alpaca && cd -
-fi
-
 mkdir -p ${output_dir} ${log_dir}
 
 deepspeed ${deepspeed_args} \
   examples/finetune.py \
-    --model_name_or_path gpt2 \
+    --model_name_or_path ${model_name_or_path} \
     --dataset_path ${dataset_path} \
     --output_dir ${output_dir} --overwrite_output_dir \
     --num_train_epochs 0.01 \

diff --git a/scripts/run_finetune_with_lora.sh b/scripts/run_finetune_with_lora.sh
@@ -1,26 +1,47 @@
 #!/bin/bash
 # Please run this script under ${project_id} in project directory of
 
-deepspeed_args="--master_port=11000"      # Default argument
-if [ $# -ge 1 ]; then
-  deepspeed_args="$1"
-fi
+# Parses arguments
+model_name_or_path=gpt2
+dataset_path=data/alpaca/train
+output_dir=output_models/finetune
+deepspeed_args="--master_port=11000"
 
+while [[ $# -ge 1 ]]; do
+  key="$1"
+  case ${key} in
+    -m|--model_name_or_path)
+      model_name_or_path="$2"
+      shift
+      ;;
+    -d|--dataset_path)
+      dataset_path="$2"
+      shift
+      ;;
+    -o|--output_lora_path)
+      output_dir="$2"
+      shift
+      ;;
+    --deepspeed_args)
+      deepspeed_args="$2"
+      shift
+      ;;
+    *)
+      echo "error: unknown option \"${key}\"" 1>&2
+      exit 1
+  esac
+  shift
+done
+
+# Finetune
 exp_id=finetune_with_lora
 project_dir=$(cd "$(dirname $0)"/..; pwd)
-output_dir=${project_dir}/output_models/${exp_id}
 log_dir=${project_dir}/log/${exp_id}
-
-dataset_path=${project_dir}/data/alpaca/train
-if [ ! -d ${dataset_path} ]; then
-  cd data && ./download.sh alpaca && cd -
-fi
-
 mkdir -p ${output_dir} ${log_dir}
 
 deepspeed ${deepspeed_args} \
   examples/finetune.py \
-    --model_name_or_path facebook/galactica-1.3b \
+    --model_name_or_path ${model_name_or_path} \
     --dataset_path ${dataset_path} \
     --output_dir ${output_dir} --overwrite_output_dir \
     --num_train_epochs 0.01 \
@@ -32,7 +53,7 @@ deepspeed ${deepspeed_args} \
     --save_aggregated_lora 0\
     --deepspeed configs/ds_config_zero2.json \
     --fp16 \
-    --run_name finetune_with_lora \
+    --run_name ${exp_id} \
     --validation_split_percentage 0 \
     --logging_steps 20 \
     --do_train \

diff --git a/scripts/run_finetune_with_lora_save_aggregated_weights.sh b/scripts/run_finetune_with_lora_save_aggregated_weights.sh
@@ -1,27 +1,47 @@
 #!/bin/bash
 # Please run this script under ${project_id} in project directory of
 
-deepspeed_args="--master_port=11000"      # Default argument
-if [ $# -ge 1 ]; then
-  deepspeed_args="$1"
-fi
+# Parses arguments
+model_name_or_path=gpt2
+dataset_path=data/alpaca/train
+output_dir=output_models/finetune
+deepspeed_args="--master_port=11000"
 
+while [[ $# -ge 1 ]]; do
+  key="$1"
+  case ${key} in
+    -m|--model_name_or_path)
+      model_name_or_path="$2"
+      shift
+      ;;
+    -d|--dataset_path)
+      dataset_path="$2"
+      shift
+      ;;
+    -o|--output_model_path)
+      output_dir="$2"
+      shift
+      ;;
+    --deepspeed_args)
+      deepspeed_args="$2"
+      shift
+      ;;
+    *)
+      echo "error: unknown option \"${key}\"" 1>&2
+      exit 1
+  esac
+  shift
+done
+
+# Finetune
 exp_id=finetune_with_lora
 project_dir=$(cd "$(dirname $0)"/..; pwd)
-output_dir=${project_dir}/output_models/${exp_id}
 log_dir=${project_dir}/log/${exp_id}
-
-dataset_path=${project_dir}/data/alpaca/train
-eval_dataset_path=${project_dir}/data/alpaca/test
-if [ ! -d ${dataset_path} ]; then
-  cd data && ./download.sh alpaca && cd -
-fi
-
 mkdir -p ${output_dir} ${log_dir}
 
 deepspeed ${deepspeed_args} \
   examples/finetune.py \
-    --model_name_or_path facebook/galactica-1.3b \
+    --model_name_or_path ${model_name_or_path} \
     --dataset_path ${dataset_path} \
     --output_dir ${output_dir} --overwrite_output_dir \
     --num_train_epochs 0.01 \
@@ -33,14 +53,10 @@ deepspeed ${deepspeed_args} \
     --save_aggregated_lora 1\
     --deepspeed configs/ds_config_zero2.json \
     --fp16 \
-    --run_name finetune_with_lora \
+    --run_name ${exp_id} \
     --validation_split_percentage 0 \
     --logging_steps 20 \
     --do_train \
-    --do_eval \
-    --evaluation_strategy "steps" \
-    --eval_steps 1000 \
-    --eval_dataset_path ${eval_dataset_path} \
     --ddp_timeout 72000 \
     --save_steps 5000 \
     --dataloader_num_workers 1 \