added description of dataset

SPIDER.py

@@ -81,8 +81,7 @@ _CITATION = """\
 }
 """
 
-# TODO: Add description of the dataset here
-# You can copy an official description
+# Official description
 _DESCRIPTION = """\
 This is a large publicly available multi-center lumbar spine magnetic resonance \
 imaging (MRI) dataset with reference segmentations of vertebrae, intervertebral \
@@ -114,7 +113,11 @@ following degenerative changes:
 
 7.    Pfirrman grade (grade 1 to 5). 
 
-All radiological gradings are provided per IVD level."""
+All radiological gradings are provided per IVD level.
+
+Repository: https://zenodo.org/records/10159290
+Paper: https://www.nature.com/articles/s41597-024-03090-w
+"""
 
 _HOMEPAGE = "https://zenodo.org/records/10159290"
 
@@ -165,7 +168,8 @@ class CustomBuilderConfig(datasets.BuilderConfig):
 
 
 class SPIDER(datasets.GeneratorBasedBuilder):
-    """TODO: Short description of my dataset.""" #TODO
+    """Resized/rescaled 3-dimensional volumetric arrays of lumbar spine MRIs \
+    with corresponding scanner/patient metadata and radiological gradings."""
 
     # Class attributes
     DEFAULT_WRITER_BATCH_SIZE = 16 # PyArrow default is too large for image data
@@ -183,19 +187,6 @@ class SPIDER(datasets.GeneratorBasedBuilder):
     ]
     DEFAULT_CONFIG_NAME = "default"
 
-    # def __init__(
-    #     self,
-    #     *args,
-    #     scan_types: List[str] = DEFAULT_SCAN_TYPES,
-    #     resize_shape: Tuple[int, int, int] = DEFAULT_RESIZE,
-    #     shuffle: bool = True,
-    #     **kwargs,
-    # ):
-    #     super().__init__(*args, **kwargs)
-    #     self.scan_types = self.scan_types
-    #     self.resize_shape = self.resize_shape
-    #     self.shuffle = self.shuffle
-
     def _info(self):
         """Specify datasets.DatasetInfo object containing information and typing
         for the dataset."""
@@ -211,46 +202,6 @@ class SPIDER(datasets.GeneratorBasedBuilder):
                 k:datasets.Value(v) for k,v in 
                 self.config.var_types['metadata'].items()
             },
-            #     {
-            #     "num_vertebrae": datasets.Value("int16"),
-            #     "num_discs": datasets.Value("int16"),
-            #     "sex": datasets.Value("string"),
-            #     "birth_date": datasets.Value("string"),
-            #     "AngioFlag": datasets.Value("string"),
-            #     "BodyPartExamined": datasets.Value("string"),
-            #     "DeviceSerialNumber": datasets.Value("string"),
-            #     "EchoNumbers": datasets.Value("float32"),
-            #     "EchoTime": datasets.Value("float32"),
-            #     "EchoTrainLength": datasets.Value("float32"),
-            #     "FlipAngle": datasets.Value("float32"),
-            #     "ImagedNucleus": datasets.Value("string"),
-            #     "ImagingFrequency": datasets.Value("float32"),
-            #     "InPlanePhaseEncodingDirection": datasets.Value("string"),
-            #     "MRAcquisitionType": datasets.Value("string"),
-            #     "MagneticFieldStrength": datasets.Value("float32"),
-            #     "Manufacturer": datasets.Value("string"),
-            #     "ManufacturerModelName": datasets.Value("string"),
-            #     "NumberOfPhaseEncodingSteps": datasets.Value("int32"),
-            #     "PercentPhaseFieldOfView": datasets.Value("float64"),
-            #     "PercentSampling": datasets.Value("float64"),
-            #     "PhotometricInterpretation": datasets.Value("string"),
-            #     "PixelBandwidth": datasets.Value("int32"),
-            #     "PixelSpacing": datasets.Sequence(datasets.Value("float32")),
-            #     "RepetitionTime": datasets.Value("float64"),
-            #     "SAR": datasets.Value("float64"),
-            #     "SamplesPerPixel": datasets.Value("int32"),
-            #     "ScanningSequence": datasets.Value("string"),
-            #     "SequenceName": datasets.Value("string"),
-            #     "SeriesDescription": datasets.Value("string"),
-            #     "SliceThickness": datasets.Value("float32"),
-            #     "SoftwareVersions": datasets.Sequence(datasets.Value("string")),
-            #     "SpacingBetweenSlices": datasets.Value("float32"),
-            #     "SpecificCharacterSet": datasets.Value("string"),
-            #     "TransmitCoilName": datasets.Value("string"),
-            #     "WindowCenter": datasets.Value("float32"),
-            #     "WindowWidth": datasets.Value("float32"),
-            #     "OrigSubset":datasets.Value("string"),
-            # },
             "rad_gradings": {
                 "IVD label": datasets.Sequence(datasets.Value("string")),
                 "Modic": datasets.Sequence(datasets.Value("string")),