Skip to content

Commit

Permalink
Add docstring for the dataset
Browse files Browse the repository at this point in the history
  • Loading branch information
anwai98 committed Mar 17, 2024
1 parent 3fc1fc0 commit ca0a761
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions torch_em/data/datasets/dynamicnuclearnet.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ def _create_dataset(path, zip_path):
def get_dynamicnuclearnet_dataset(
path, split, patch_shape, download=False, **kwargs
):
"""TODO"""
"""Dataset for the segmentation of cell nuclei imaged with fluorescene microscopy.
This dataset is from the publication https://doi.org/10.1101/803205.
Please cite it if you use this dataset for a publication."""
splits = ["train", "val", "test"]
assert split in splits

Expand Down Expand Up @@ -81,7 +84,9 @@ def get_dynamicnuclearnet_dataset(
def get_dynamicnuclearnet_loader(
path, split, patch_shape, batch_size, download, **kwargs
):
"""TODO"""
"""Dataloader for the segmentation of cell nuclei for 5 different cell lines in fluorescence microscopes.
See `get_dynamicnuclearnet_dataset` for details.
"""
ds_kwargs, loader_kwargs = util.split_kwargs(torch_em.default_segmentation_dataset, **kwargs)
dataset = get_dynamicnuclearnet_dataset(path, split, patch_shape, download, **ds_kwargs)
loader = torch_em.get_data_loader(dataset, batch_size, **loader_kwargs)
Expand Down

0 comments on commit ca0a761

Please sign in to comment.