Skip to content

Commit 333049f

Browse files
authored
Indentation and other minor fixes in verifiable_datasets.rst (#1639)
Signed-off-by: Teodor Parvanov <[email protected]>
1 parent 735e593 commit 333049f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/developer_guide/utilities/verifiable_datasets.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To accommodate for the proliferation of data sources and the need for trusted da
1111
This includes an extensible class hierarchy that enables the creation of datasets from various data sources, such as local file system, object storage and others.
1212

1313
The central abstraction is the :code:`VerifiableDatasetInfo` class that encapsulates the dataset's metadata and provides a method for verifying the integrity of the dataset.
14-
A dataset can be built from multiple data sources (not necessarily from the same type):
14+
A dataset can be built from multiple data sources (not necessarily of the same type):
1515

1616
.. mermaid:: ../../mermaid/verifiable_dataset_info.mmd
1717
:caption: Verifiable Dataset with Multiple Data Sources
@@ -21,6 +21,7 @@ The :code:`VerifiableDatasetInfo` class can then be used to create higher-order
2121
The :code:`root_hash` is used as a reference for integrity when loading items from the the data sources in the :code:`VerifiableDatasetInfo` object.
2222

2323
OpenFL comes with a toolbox of dataset layout classes per ML framework. For PyTorch's :code:`torch.utils.data.Dataset` OpenFL curently provides:
24+
2425
- :code:`FolderDataset` - represents an iterable folder-layout dataset from a single data source, by implementing the :code:`__getitem__` method.
2526
- :code:`ImageFolder` - a specialization of the :code:`FolderDataset` that is able to load binary images from a foler-like structure
2627
- :code:`VerifiableMapStyleDataset` - a base class for map-style datasets that can be built from multiple data sources (as specified by a :code:`VerifiableDatasetInfo` object), including integrity checks.
@@ -33,4 +34,4 @@ A similar class hierarchy can be created for other ML frameworks that offer data
3334
:caption: Dataset hierarchy
3435
:align: center
3536

36-
A practical example for the :code:`VerifiableImageFolder` backed by a mix of :code:`LocalDataSource` and :code:`S3DataSource` objects is provided in the `s3_histology <https://github.com/securefederatedai/openfl/tree/develop/openfl-workspace/torch/histology_s3>`_ workspace template.
37+
A practical example for the :code:`VerifiableImageFolder` backed by :code:`S3DataSource` is provided in the `s3_histology <https://github.com/securefederatedai/openfl/tree/develop/openfl-workspace/torch/histology_s3>`_ workspace template.

0 commit comments

Comments
 (0)