From a7833cc7bd73c68b92be52e1c96d11f5d37a1391 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Fri, 17 Apr 2020 15:56:34 +0200
Subject: [PATCH] [data.dataset] Improve documentation
---
bob/ip/binseg/data/dataset.py | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/bob/ip/binseg/data/dataset.py b/bob/ip/binseg/data/dataset.py
index 7ad0e9f2..608cc2ae 100644
--- a/bob/ip/binseg/data/dataset.py
+++ b/bob/ip/binseg/data/dataset.py
@@ -61,8 +61,8 @@ class JSONDataset:
the JSON file.
loader : object
- A function that receives as input, a context dictionary (with a
- "protocol" and "subset" keys indicating which protocol and subset are
+ A function that receives as input, a context dictionary (with at least
+ a "protocol" and "subset" keys indicating which protocol and subset are
being served), and a dictionary with ``{key: path}`` entries, and
returns a dictionary with the loaded data.
@@ -204,9 +204,10 @@ class CSVDataset:
the CSV file(s).
loader : object
- A function that receives, as input, a dictionary with ``{name: value}``
- entries (for each header in the input CSV file), and returns a
- dictionary with the loaded data.
+ A function that receives as input, a context dictionary (with, at
+ least, a "subset" key indicating which subset is being served), and a
+ dictionary with ``{key: path}`` entries, and returns a dictionary with
+ the loaded data.
keymaker : object
A function that receives as input the same input from the ``loader``,
--
GitLab