Update README.md

README.md

@@ -96,6 +96,61 @@ Simulation-based testing is constrained to the parameter variability represented
 There is a risk of misjudging model performance if the simulated examples do not capture the variability in real patients. Please
 see the paper for a full discussion of biases, risks, and limitations.
 
+## How to use it
+The msynth dataset is a very large dataset so for most use cases it is recommended to make use of the streaming API of `datasets`. 
+The msynth dataset has three configurations: 1) device_data, 2) segmentation_mask, and 3) metadata 
+You can load and iterate through the dataset using the configurations with the following lines of code:
+
+```python
+from datasets import load_dataset
+ds = load_dataset("didsr/msynth", 'device_data') # For device data for all breast density, mass redius, mass density, and relative dose, change configuration to 'segmentation_mask' and 'metadata' to load the segmentation masks and bound information 
+print(ds_data["device_data"])
+
+# A sample data instance
+
+{'Raw': '~\\.cache\\huggingface\\datasets\\downloads\\extracted\\59384cf05fc44e8c0cb23bb19e1fcd8f0c39720b282109d204a85561fe66bdb1\\SIM\\P2_5.0_fatty.8336179.1\\1\\projection_DM1.raw',
+ 'mhd': '~/.cache/huggingface/datasets/downloads/extracted/59384cf05fc44e8c0cb23bb19e1fcd8f0c39720b282109d204a85561fe66bdb1/SIM/P2_5.0_fatty.8336179.1/1\\projection_DM1.mhd',
+ 'loc': '~/.cache/huggingface/datasets/downloads/extracted/59384cf05fc44e8c0cb23bb19e1fcd8f0c39720b282109d204a85561fe66bdb1/SIM/P2_5.0_fatty.8336179.1/1\\projection_DM1.loc',
+ 'dcm': '~/.cache/huggingface/datasets/downloads/extracted/59384cf05fc44e8c0cb23bb19e1fcd8f0c39720b282109d204a85561fe66bdb1/SIM/P2_5.0_fatty.8336179.1/1\\DICOM_dm\\000.dcm',
+ 'density': 'fatty',
+ 'mass_radius': 5.0}
+```
+Msynth dataset can also be loaded using custom breast density, mass redius, mass density, and relative dose information
+
+```python
+from datasets import load_dataset
+
+# Dataset properties. change to 'all' to include all the values of breast density, mass redius, mass density, and relative dose information
+config_kwargs = {
+    "lesion_density": ["1.0"], 
+    "dose": ["20%"],
+    "density": ["fatty"],
+    "size": ["5.0"]
+}
+
+# Loading device data
+ds_data = load_dataset("didsr/msynth", 'device_data', **config_kwargs)
+# Loading segmentation-mask
+ds_seg = load_dataset("didsr/msynth", 'segmentation_mask', **config_kwargs)
+```
+The meta data can also be loaded using the datasets API. An example of using metadata is given in **Demo:** [https://github.com/DIDSR/msynth-release/tree/master/examples](https://github.com/DIDSR/msynth-release/tree/master/examples)
+
+```python
+from datasets import load_dataset
+# Loading metadata 
+ds_meta = load_dataset("didsr/msynth", 'metadata')
+
+# A sample data instance
+ds_meta['metadata'][0]
+
+# Output
+
+{'fatty': '~\\.cache\\huggingface\\datasets\\downloads\\extracted\\3ea85fc6b3fcc253ac8550b5d1b21db406ca9a59ea125ff8fc63d9b754c88348\\bounds\\bounds_fatty.npy',
+ 'dense': '~\\.cache\\huggingface\\datasets\\downloads\\extracted\\3ea85fc6b3fcc253ac8550b5d1b21db406ca9a59ea125ff8fc63d9b754c88348\\bounds\\bounds_dense.npy',
+ 'hetero': '~\\.cache\\huggingface\\datasets\\downloads\\extracted\\3ea85fc6b3fcc253ac8550b5d1b21db406ca9a59ea125ff8fc63d9b754c88348\\bounds\\bounds_hetero.npy',
+ 'scattered': '~\\.cache\\huggingface\\datasets\\downloads\\extracted\\3ea85fc6b3fcc253ac8550b5d1b21db406ca9a59ea125ff8fc63d9b754c88348\\bounds\\bounds_scattered.npy'}
+
+```
 
 ## Citation
 ```