Skip to content

Commit 4db0bc4

Browse files
committed
update docstrings
1 parent e0b58df commit 4db0bc4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

histoprep/utils/_torch.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828

2929

3030
class SlideReaderDataset(Dataset):
31-
"""Torch dataset yielding tile images from reader (requires `PyTorch`)."""
31+
"""Torch dataset yielding tile images and `xywh`-coordinates from reader (requires
32+
`PyTorch`)."""
3233

3334
def __init__(
3435
self,
@@ -68,7 +69,8 @@ def __getitem__(self, index: int) -> tuple[Union[np.ndarray, Any], np.ndarray]:
6869

6970

7071
class TileImageDataset(Dataset):
71-
"""Torch dataset yielding tile images from paths (requires `PyTorch`)."""
72+
"""Torch dataset yielding tile images, image paths and optional labels (requires
73+
`PyTorch`)."""
7274

7375
def __init__(
7476
self,

0 commit comments

Comments
 (0)