From 939aa6d92ee80ba0f8ce879bd61adacdef5f5b51 Mon Sep 17 00:00:00 2001
From: Ting-Jun Wang <levi900227@gmail.com>
Date: Wed, 15 May 2024 20:55:08 +0800
Subject: [PATCH] docs: add some hint comment

---
 train/dataset.py | 6 ++++++
 train/model.py   | 5 +++++
 2 files changed, 11 insertions(+)

diff --git a/train/dataset.py b/train/dataset.py
index 6da52cf..f41d051 100644
--- 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
diff --git a/train/model.py b/train/model.py
index a658c6d..1a01104 100644
--- 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