Skip to content

Commit 227fe26

Browse files
committed
added english description
1 parent 4d47e94 commit 227fe26

File tree

3 files changed

+48
-6
lines changed

3 files changed

+48
-6
lines changed

README.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Terminal> python3 train_een_latent.py [옵션 설정]
3636
2. ``` -tfrecordspath ``` : tfrecords 파일의 디렉토리 (존재하지 않는다면 설정한 디렉토리로 자동 생성됨)
3737
3. ```-model_name``` (only deterministic 모델) : 학습한 모델을 저장할 디렉토리 및 파일명 (기본값: './model/deterministic/deterministic_model')
3838
4. ```-model_path``` (only latent 모델) : deterministic 모델을 불러올 디렉토리 및 파일명 (기본값: './model/deterministic/deterministic_model-19.meta')
39-
5. ``` -save_dir ``` : 학습한 모델을 저장할 디렉토리
39+
5. ``` -save_dir ``` : 학습한 모델을 저장할 디렉토리 (기본값: './results/')
4040

4141
#### 이외의 옵션들
4242
1. ``` -width ``` : 학습할 때 사용할 프레임의 너비(픽셀단위) (기본값: 480)
@@ -53,6 +53,48 @@ Terminal> python3 train_een_latent.py [옵션 설정]
5353
### 3. Visualization
5454
<i>개발중</i>
5555
## Usage - English
56-
### Data
57-
### Training
58-
### Visualization
56+
#### Required Directory
57+
58+
Project Directory
59+
├ models.py
60+
├ dataloader.py
61+
├ train_een_deterministic.py
62+
├ train_een_latent.py
63+
├── data (need to be created --> where videos and tfrecord are stored)
64+
│ ├── flower.mp4 (Need to add at least one video to train)
65+
│ ├── dataset.tfrecords (auto created if not exist)
66+
│ └── ...
67+
└── model (need to be created --> where trained deterministic models are stored)
68+
69+
### 1. Data
70+
Clone this repository and make ```./data``` directory. Add video you want to train.
71+
### 2. Training
72+
#### Training Deterministic Model
73+
```
74+
Terminal> python3 train_een_deterministic.py [initialize options]
75+
```
76+
#### Training Latent Residual Model
77+
```
78+
Terminal> python3 train_een_latent.py [initialize options]
79+
```
80+
#### Crucial Options to Check
81+
1. ``` -videopath ``` : directory of training video
82+
2. ``` -tfrecordspath ``` : tfrecords file directory (auto created if not exist)
83+
3. ```-model_name``` (only deterministic model) : deterministic model path (default: './model/deterministic/deterministic_model')
84+
4. ```-model_path``` (only latent model) : latent model path (default: './model/deterministic/deterministic_model-19.meta')
85+
5. ``` -save_dir ``` : where models are saved (default: './results/')
86+
87+
#### More options to go through
88+
1. ``` -width ``` : wanted width for training(pixel) (default: 480)
89+
2. ``` -height ``` : wanted height for training(pixel) (default: 480)
90+
3. ``` -pred_frame ``` : number of frames to learn and predict (default: 5)
91+
4. ``` -time_interval ``` : time interval between frames in milliseconds (default: 2)
92+
5. ``` -data_interval ``` : number of frame interval between start of each dataset (default: 150)
93+
6. ``` -batch_size ``` : batch size (default: 5)
94+
7. ``` -nfeature ``` : number of feature maps in convnet (default: 64)
95+
8. ``` -nlatent ``` : Number of Latent Variables (default: 4) ** train_een_latent.py ONLY**
96+
9. ``` -lrt ``` : learning rate (default: 0.0005)
97+
10. ``` -epoch ``` : number of training epoch (default: 500)
98+
99+
### 3. Visualization
100+
<i>In Development</i>

train_een_deterministic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
parser.add_argument('-videopath', type=str, default='./data/flower.mp4', help='video folder')
3333
parser.add_argument('-tfrecordspath', type=str, default='./data/dataset.tfrecords', help='tfrecords file path')
3434
parser.add_argument('-model_name', type=str, default='./model/deterministic/deterministic_model', help='deterministic model path')
35-
parser.add_argument('-save_dir', type=str, default='./results/', help='where to save the models')
35+
parser.add_argument('-save_dir', type=str, default='./results/', help='where models are saved')
3636
arg = parser.parse_args()
3737

3838
### Setup Training Environment ###

train_een_latent.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
parser.add_argument('-videopath', type=str, default='./data/flower.mp4', help='video folder')
3434
parser.add_argument('-tfrecordspath', type=str, default='./data/dataset.tfrecords', help='tfrecords file path')
3535
parser.add_argument('-model_path', type=str, default='./model/deterministic/deterministic_model-20.meta', help='deterministic model path')
36-
parser.add_argument('-save_dir', type=str, default='./results/', help='where to save the models')
36+
parser.add_argument('-save_dir', type=str, default='./results/', help='where models are saved')
3737
arg = parser.parse_args()
3838

3939
### Setup Training Environment ###

0 commit comments

Comments
 (0)