From d6ef3b0d714744cd7393b9b111940543df8b8d6f Mon Sep 17 00:00:00 2001
From: Tim Laibacher <tim.laibacher@idiap.ch>
Date: Thu, 5 Sep 2019 12:17:45 +0200
Subject: [PATCH] Add python-api docs
---
bob/ip/binseg/data/imagefolder.py | 12 ++++--------
doc/api.rst | 8 ++++++--
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/bob/ip/binseg/data/imagefolder.py b/bob/ip/binseg/data/imagefolder.py
index 3f71f4e1..da667024 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 af7e4ecc..a6608a63 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::
--
GitLab