Skip to content

Open-Sora: Democratizing Efficient Video Production for All

Python

added training scripts and readme (#12)

Frank Leea33c656c8022
diff --git a/.gitignore b/.gitignore
index 31a93e1..5296d86 100644
--- a/.gitignore
+++ b/.gitignore
@@ -160,5 +160,7 @@ cython_debug/
#.idea/
.vscode/
-# files needed to train
+# misc files
dataset/
+runs/
+checkpoints/
diff --git a/README.md b/README.md
index fb44ec2..b17d404 100644
--- a/README.md
+++ b/README.md
@@ -94,7 +94,13 @@ pip install -r requirements.txt
### Training
-To be added.
+You can invoke the training via the command below.
+
+```bash
+bash ./scripts/train.sh
+```
+
+You can also modify the arguments in `train.sh` for your own need.
### Inference
diff --git a/requirements.txt b/requirements.txt
index 1ec0061..638876b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -3,3 +3,4 @@ torchvision
datasets
transformers
av
+tensorboard
diff --git a/scripts/train.sh b/scripts/train.sh
new file mode 100644
index 0000000..bd02dbd
--- /dev/null
+++ b/scripts/train.sh
@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+# get args
+GPUS=${1:8}
+
+# get root dir
+FOLDER_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+ROOT_DIR=$FOLDER_DIR/..
+
+# go to root dir
+cd $ROOT_DIR
+
+# define dataset shards
+COLLATED_VIDEO_DIR=./dataset/MSRVTT-collated/val/videos
+PROCESSED_DATASET=(
+ ./dataset/MSRVTT-processed/val/part-00000
+ ./dataset/MSRVTT-processed/val/part-00001
+ ./dataset/MSRVTT-processed/val/part-00002
+ ./dataset/MSRVTT-processed/val/part-00003
+ ./dataset/MSRVTT-processed/val/part-00004
+ ./dataset/MSRVTT-processed/val/part-00005
+ ./dataset/MSRVTT-processed/val/part-00006
+ ./dataset/MSRVTT-processed/val/part-00007
+ ./dataset/MSRVTT-processed/val/part-00008
+ ./dataset/MSRVTT-processed/val/part-00009
+)
+
+# run single node training
+torchrun --standalone \
+ --nproc_per_node $GPUS \
+ train.py \
+ --epochs 1 \
+ --batch_size 1 \
+ --lr 1e-4 \
+ --accumulation_steps 32 \
+ --grad_checkpoint \
+ --dataset $PROCESSED_DATASET \
+ --video_dir $COLLATED_VIDEO_DIR \
+ --save_interval 224 \
+ --checkpoint_dir ./checkpoints \
+ --tensorboard_dir ./runs