Skip to content

Commit 50f12ee

Browse files
committed
Slight aesthetic update to docs again.
1 parent 5d95379 commit 50f12ee

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

src/pyremotedata/dataloader.py

+10-7
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ class RemotePathDataset(IterableDataset):
2424
2525
By default the dataset will return the image as a tensor and the remote path as a string.
2626
27-
"""""""""""""""""""""
2827
**Hierarchical mode**
29-
"""""""""""""""""""""
30-
| If `hierarchical` >= 1, the dataset is in "Hierarchical mode" and will return the image as a tensor and the label as a list of integers (class indices for each level in the hierarchy).
31-
| The `class_handles` property can be used to get the class-idx mappings for the dataset.
32-
| By default the dataset will use a parser which assumes that the hierarchical levels are encoded in the remote path as directories like so:
33-
| `.../level_n/.../level_1/level_0/image.jpg`
34-
| Where `n = (hierarchical - 1)` and `level_0` is the leaf level.
28+
29+
If `hierarchical` >= 1, the dataset is in "Hierarchical mode" and will return the image as a tensor and the label as a list of integers (class indices for each level in the hierarchy).
30+
31+
The `class_handles` property can be used to get the class-idx mappings for the dataset.
32+
33+
By default the dataset will use a parser which assumes that the hierarchical levels are encoded in the remote path as directories like so:
34+
35+
`.../level_n/.../level_1/level_0/image.jpg`
36+
37+
Where `n = (hierarchical - 1)` and `level_0` is the leaf level.
3538
3639
Args:
3740
remote_path_iterator (RemotePathIterator): The remote path iterator to create the dataset from.

0 commit comments

Comments
 (0)