improve aligned_dataset

Author: junyanz

data/__init__.py

@@ -1,4 +1,14 @@
-"""This package """
+"""This package includes all the modules related to data loading and Preprocessing
+
+ To add a custom dataset class called dummy, you need to add a file called 'dummy_dataset.py' and define a subclass 'DummyDataset' inherited from BaseDataset.
+ You need to implement four functions:
+    -- <__init__> (initialize the class, first call BaseDataset.__init__(self, opt))
+    -- <__len__> (return the size of dataset)
+    -- <__getitem__>　(get a data point)
+    -- (optionally) <modify_commandline_options> (add dataset-specific options and set default options).
+Now you can use the dataset class by specifying flag '--dataset_mode dummy'.
+See our template dataset class 'template_dataset.py' for an example.
+"""
 import importlib
 import torch.utils.data
 from data.base_dataset import BaseDataset

data/aligned_dataset.py

@@ -10,15 +10,14 @@ class AlignedDataset(BaseDataset):
     """A dataset class for paired image dataset.
 
     It assumes that the directory '/path/to/data/train' contains image pairs in the form of {A,B}.
-    During test time, you need to prepare a directory /path/to/data/test.
+    During test time, you need to prepare a directory '/path/to/data/test'.
     """
 
     def __init__(self, opt):
         """Initialize this dataset class."""
         BaseDataset.__init__(self, opt)
         self.dir_AB = os.path.join(opt.dataroot, opt.phase)  # get the image directory
         self.AB_paths = sorted(make_dataset(self.dir_AB, opt.max_dataset_size))  # get image paths
-        assert(opt.resize_or_crop == 'resize_and_crop')    # only support this mode
         assert(self.opt.load_size >= self.opt.crop_size)   # crop_size should be smaller than the size of loaded image
         input_nc = self.opt.output_nc if self.opt.direction == 'BtoA' else self.opt.input_nc
         output_nc = self.opt.input_nc if self.opt.direction == 'BtoA' else self.opt.output_nc

data/template_dataset.py

@@ -6,10 +6,10 @@
 The filename should be <dataset_mode>_dataset.py
 The class name should be <Dataset_mode>Dataset.py
 You need to implement the following functions:
-    <modify_commandline_options>:　Add dataset-specific options and rewrite default values for existing options.
-    <__init__>: Initialize this dataset class.
-    <__getitem__>: Return a data point and its metadata information.
-    <__len__>: Return the number of images.
+    -- <modify_commandline_options>:　Add dataset-specific options and rewrite default values for existing options.
+    -- <__init__>: Initialize this dataset class.
+    -- <__getitem__>: Return a data point and its metadata information.
+    -- <__len__>: Return the number of images.
 """
 from data.base_dataset import BaseDataset, get_transform
 # from data.image_folder import make_dataset