docs: add some hint comment

2024-05-15 20:55:08 +08:00 · 2024-05-15 20:55:08 +08:00 · 939aa6d92e
commit 939aa6d92e
parent e7572347c9
2 changed files with 11 additions and 0 deletions
--- a/train/dataset.py
+++ b/train/dataset.py
@ -1,3 +1,9 @@
+'''
+
+    Please implement a Dataset which inherit the PyTorch Dataset class.
+    So that our trainer can load the data from /dataset_dir
+
+'''
 import os
 import numpy as np
 from torch.utils.data import Dataset, DataLoader
--- a/train/model.py
+++ b/train/model.py
@ -1,3 +1,8 @@
+'''
+
+    Please Implement your model here.
+
+'''
 from torch import nn
 import torch.nn.functional as F