Skip to content

Commit 3ecc35b

Browse files
committed
Update HDF5 docstrings
1 parent 9a45312 commit 3ecc35b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/containers/hdf5dataset.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ end
1212
1313
Wrap several HDF5 datasets (`paths`) as a single dataset container.
1414
Each dataset `p` in `paths` should be accessible as `fid[p]`.
15+
Calling `getobs` on a `HDF5Dataset` returns a tuple with each element corresponding
16+
to the observation from each dataset in `paths`.
1517
See [`close(::HDF5Dataset)`](@ref) for closing the underlying HDF5 file pointer.
1618
1719
For array datasets, the last dimension is assumed to be the observation dimension.
@@ -47,4 +49,9 @@ MLUtils.getobs(dataset::HDF5Dataset, i) = Tuple(map(dataset.paths, dataset.shape
4749
end)
4850
MLUtils.numobs(dataset::HDF5Dataset) = last(first(filter(!isempty, dataset.shapes)))
4951

52+
"""
53+
close(dataset::HDF5Dataset)
54+
55+
Close the underlying HDF5 file pointer for `dataset`.
56+
"""
5057
Base.close(dataset::HDF5Dataset) = close(dataset.fid)

0 commit comments

Comments
 (0)