Update docs for BaseGenerator (#48)

* BaseGenerator.py: Fix documentation of function get_images().

Fix dimensions of __doc__ attribute from (1, height, width, n_channels) to (n_indexes, height, width, n_channels).

* BaseGenerator.py: Fix documentation of function get_keypoints().

Fix dimensions of __doc__ attribute from (1, n_keypoints, 2) to (n_indexes, n_keypoints, 2).

* BaseGenerator.py: Fix documentation of function get_images().

Fix dimensions of __doc__ attribute from (n_indexes, height, width, n_channels) to (n_samples, height, width, n_channels).

* BaseGenerator.py: Fix documentation of function get_keypoints().

Fix dimensions of __doc__ attribute from (n_indexes, n_keypoints, 2) to (n_samples, n_keypoints, 2).

deepposekit/io/BaseGenerator.py

@@ -74,7 +74,7 @@ def get_images(self, indexes):
         Takes a list or array of indexes corresponding
         to image-keypoint pairs in the dataset.
         Returns a numpy array of images with the shape:
-        (1, height, width, n_channels)
+        (n_samples, height, width, n_channels)
         """
         raise NotImplementedError()
 
@@ -83,7 +83,7 @@ def get_keypoints(self, indexes):
         Takes a list or array of indexes corresponding to
         image-keypoint pairs in the dataset.
         Returns a numpy array of keypoints with the shape:
-        (1, n_keypoints, 2), where 2 is the x,y coordinates
+        (n_samples, n_keypoints, 2), where 2 is the x,y coordinates
         """
         raise NotImplementedError()