diff --git a/bob/ip/binseg/data/imagefolder.py b/bob/ip/binseg/data/imagefolder.py index 3f71f4e1d518b0c41b2e6bb8e3b0267b16c1874d..da6670241afd4d2533fca8021a15e4e85d91bdb8 100644 --- a/bob/ip/binseg/data/imagefolder.py +++ b/bob/ip/binseg/data/imagefolder.py @@ -19,10 +19,10 @@ def get_file_lists(data_path): class ImageFolder(Dataset): """ - Required directory tree structure for images and ground-truth (gt): - root - |- images - |- gt + Generic ImageFolder dataset, that contains two folders: + + * ``images`` (vessel images) + * ``gt`` (ground-truth labels) Parameters @@ -30,10 +30,6 @@ class ImageFolder(Dataset): path : str full path to root of dataset - Returns - ------- - [type] - [description] """ def __init__(self, path, transform = None): self.transform = transform diff --git a/doc/api.rst b/doc/api.rst index af7e4ecce8bff89677007807e71029e5fbb2a8a6..a6608a637c5a55b0e73a3d15c54364c4b8f37ffa 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -9,10 +9,14 @@ This section lists all the functionality available in this library allowing to run binary-segmentation benchmarks. -PyTorch Dataset -=============== +PyTorch bob.db Dataset +====================== .. automodule:: bob.ip.binseg.data.binsegdataset +PyTorch ImageFolder Dataset +=========================== +.. automodule:: bob.ip.binseg.data.imagefolder + Transforms ========== .. note::