diff --git a/bob/bio/base/utils/io.py b/bob/bio/base/utils/io.py index f8dcddcc93629bf58a842d45a4c773115f9baac3..d1f43cb9498a28497e133a7e3afa5c44c21ca194 100644 --- a/bob/bio/base/utils/io.py +++ b/bob/bio/base/utils/io.py @@ -190,7 +190,7 @@ def _generate_features(reader, paths): Yields ------ object - The first object returned is the :py:type:`numpy.dtype` of features. The + The first object returned is the :py:class:`numpy.dtype` of features. The second objects returned is the shape of the first feature. The rest of objects are the actual values in features. The features are returned in C order. @@ -272,11 +272,11 @@ def vstack_features(reader, paths, same_size=False): ---------- reader : collections.Callable The function to load the features. The function should only take one - argument being the path to the features. Use :py:type:`functools.partial` - to accommodate your reader to this format. The features returned by - ``reader`` are expected to have the same :py:type:`numpy.dtype` and the - same shape except for their first dimension. First dimension is should - correspond to the number of samples. + argument being the path to the features. Use + :any:`functools.partial` to accommodate your reader to this format. + The features returned by ``reader`` are expected to have the same + :py:class:`numpy.dtype` and the same shape except for their first + dimension. First dimension is should correspond to the number of samples. paths : collections.Iterable An iterable of paths to iterate on. Whatever is inside path is given to ``reader``. If ``same_size`` is ``True``, ``len(paths)`` must be valid. @@ -288,7 +288,7 @@ def vstack_features(reader, paths, same_size=False): Returns ------- numpy.ndarray - The read features with the shape (n_samples, *features_shape[1:]). + The read features with the shape (n_samples, \*features_shape[1:]). """ iterable = _generate_features(reader, paths) dtype = next(iterable) diff --git a/doc/py_api.rst b/doc/py_api.rst index a43beead5e5c32c6ea92aefbea50a2232b2457df..cd2f90f3c39a6ba396fd38e9e27ed70024f10970 100644 --- a/doc/py_api.rst +++ b/doc/py_api.rst @@ -17,6 +17,7 @@ IO-related functions bob.bio.base.open_compressed bob.bio.base.close_compressed bob.bio.base.check_file + bob.bio.base.vstack_features Functions dealing with resources