Update README.md

README.md

@@ -21,3 +21,31 @@ dataset_info:
   download_size: 54700022689
   dataset_size: 54704422046
 ---
+# CellMap 2D
+
+This dataset contains all 2D slices from the EM volumes used in the [CellMap segmentation challenge](https://cellmapchallenge.janelia.org/). 
+The dataset contains all *x*, *y*, *z* slices obtained from a total of 289 3D crops (the crops come from 22 different samples).  
+
+You can load the dataset as follows (*non-streaming* mode):
+```python
+ds = load_dataset("eminorhan/cellmap-2d", split='train')
+```
+and then inspect the first data row:
+```python
+>>> print(ds[0])
+>>> {
+'image': <PIL.PngImagePlugin.PngImageFile image mode=L size=300x300 at 0xFFF93926C850>,
+'crop_name': 'jrc_mus-kidney/recon-1/crop129',
+'axis': 'z',
+'slice': 0
+}
+```
+where:
+* `image` contains the actual 2D slice encoded as a `PIL.Image` object. 
+* `crop_name` is an identifier string indicating the sample and crop names the slice comes from.
+* `axis` indicates the axis along which the slice was taken (`x`, `y`, or `z`).
+* `slice` is the slice index along the `axis`.
+
+Please note that the dataset rows are **not** pre-shuffled.
+
+**License:** The data originally come from HHMI Janelia's [OpenOrganelle](https://www.openorganelle.org/) data portal and are [released](https://www.openorganelle.org/faq#sharing) under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en) license.