Update configs to a single deafult with kwargs

README.md

@@ -29,7 +29,6 @@ tags:
 - nlp
 - wikipedia
 dataset_info:
-- config_name: default
   features:
   - name: id
     dtype: string
@@ -45,8 +44,8 @@ dataset_info:
     sequence:
       class_label:
         names:
-          '0': neg
-          '1': pos
+          '0': semantic-continuity
+          '1': semantic-break
   splits:
   - name: train
     num_bytes: 4754764877
@@ -59,61 +58,5 @@ dataset_info:
     num_examples: 73232
   download_size: 1569504207
   dataset_size: 5958006898
-- config_name: titled
-  features:
-  - name: id
-    dtype: string
-  - name: sent_ids
-    sequence: string
-  - name: sentences
-    sequence: string
-  - name: titles_mask
-    sequence: uint8
-  - name: levels
-    sequence: uint8
-  - name: labels
-    sequence:
-      class_label:
-        names:
-          '0': neg
-          '1': pos
-  splits:
-  - name: train
-    num_bytes: 4754764877
-    num_examples: 582160
-  - name: validation
-    num_bytes: 595209014
-    num_examples: 72354
-  - name: test
-    num_bytes: 608033007
-    num_examples: 73232
-  download_size: 1569504207
-  dataset_size: 5958006898
-- config_name: untitled
-  features:
-  - name: id
-    dtype: string
-  - name: sent_ids
-    sequence: string
-  - name: sentences
-    sequence: string
-  - name: labels
-    sequence:
-      class_label:
-        names:
-          '0': neg
-          '1': pos
-  splits:
-  - name: train
-    num_bytes: 4565834833
-    num_examples: 582160
-  - name: validation
-    num_bytes: 571636978
-    num_examples: 72354
-  - name: test
-    num_bytes: 583978545
-    num_examples: 73232
-  download_size: 1569504207
-  dataset_size: 5721450356
 ---
 # Dataset Card for Wiki-727K Dataset

wiki727k.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 # TODO: Address all TODOs and remove all explanatory comments
 """
-Wiki-727k dataset loading script responsible for downloading and extracting raw data files, followed by parsing the articles into lists of setnences and their binary text segmentation labels.
+Wiki-727K dataset loading script responsible for downloading and extracting raw data files, followed by parsing the articles into lists of setnences and their binary text segmentation labels.
 See https://github.com/koomri/text-segmentation for more information.
 
 Usage:
@@ -58,7 +58,7 @@ _CITATION = """\
 # TODO: Add description of the dataset here
 # You can copy an official description
 _DESCRIPTION = """\
-Wiki727k is a large dataset for text segmentation that is automatically extracted and labeled from Wikipedia.
+Wiki-727K is a large dataset for text segmentation that is automatically extracted and labeled from Wikipedia.
 This dataset is formulated as a sentence-level sequence labelling task for text segmentation.
 """
 
@@ -74,24 +74,22 @@ _LICENSE = "MIT License"
 _URL = "https://www.dropbox.com/sh/k3jh0fjbyr0gw0a/AACKW_gsxUf282QqrfH3yD10a/wiki_727K.tar.bz2?dl=1"
 
 
-# @dataclass
-# class Wiki727kBuilderConfig(datasets.BuilderConfig):
-#     """BuilderConfig for Wiki727k dataset."""
+@dataclass
+class Wiki727kBuilderConfig(datasets.BuilderConfig):
+    """BuilderConfig for Wiki-727K dataset."""
 
-#     drop_titles: Optional[bool] = None
-#     prepend_title_stack: Optional[bool] = None
+    drop_titles: Optional[bool] = False
+    prepend_title_stack: Optional[bool] = False
 
-#     def __post_init__(self):
-#         # if self.name not in ["default"]:
-#         #     raise ValueError(f"Unknown configuration name: {self.name}")    
-#         if self.drop_titles and self.prepend_title_stack:
-#             raise ValueError("Prepend title stack is not compatible with drop titles.")
-#         super(Wiki727kBuilderConfig, self).__post_init__()
+    def __post_init__(self):  
+        if self.drop_titles and self.prepend_title_stack:
+            raise ValueError("Prepend title stack is not compatible with drop titles.")
+        super(Wiki727kBuilderConfig, self).__post_init__()
 
 
 # TODO: Name of the dataset usually matches the script name with CamelCase instead of snake_case
 class Wiki727k(datasets.GeneratorBasedBuilder):
-    """Wiki727k dataset formulated as a sentence-level sequence labelling task for text segmentation."""
+    """Wiki-727K dataset formulated as a sentence-level sequence labelling task for text segmentation."""
 
     VERSION = datasets.Version("1.0.0")
 
@@ -101,21 +99,21 @@ class Wiki727k(datasets.GeneratorBasedBuilder):
 
     # If you need to make complex sub-parts in the datasets with configurable options
     # You can create your own builder configuration class to store attribute, inheriting from datasets.BuilderConfig
-    # BUILDER_CONFIG_CLASS = Wiki727kBuilderConfig
+    BUILDER_CONFIG_CLASS = Wiki727kBuilderConfig
 
     # You will be able to load one or the other configurations in the following list with
     # data = datasets.load_dataset('name', 'config1')
     BUILDER_CONFIGS = [
-        datasets.BuilderConfig(name="titled", version=VERSION, description="Article titles are kept alongside regular sentences in `sentences` attribute, but differentiated with positive values (i.e. 1 as opposed to 0) in `titles_mask` attribute. (Default configuration with all attributes)"),
-        datasets.BuilderConfig(name="untitled", version=VERSION, description="Article titles are droped, therefore `sentences` attribute consists of only regular sentences, and `titles_mask` attribute is not present. (Alternative configuration ready for Document Segmentation task)"),
+        Wiki727kBuilderConfig(name="default", version=VERSION, description="Default configuration of Wiki727K dataset."),
     ]
-    DEFAULT_CONFIG_NAME = "titled"  # It's not mandatory to have a default configuration. Just use one if it make sense.
+    DEFAULT_CONFIG_NAME = "default"  # It's not mandatory to have a default configuration. Just use one if it make sense.
     
     # BUILDER_CONFIGS = [
-    #     datasets.BuilderConfig(name="default", version=VERSION, description="The only configuration of the dataset."),
+    #     datasets.BuilderConfig(name="titled", version=VERSION, description="Article titles are kept alongside regular sentences in `sentences` attribute, but differentiated with positive values (i.e. 1 as opposed to 0) in `titles_mask` attribute. (Default configuration with all attributes)"),
+    #     datasets.BuilderConfig(name="untitled", version=VERSION, description="Article titles are droped, therefore `sentences` attribute consists of only regular sentences, and `titles_mask` attribute is not present. (Alternative configuration ready for Document Segmentation task)"),
     # ]
-    # DEFAULT_CONFIG_NAME = "default"
-
+    # DEFAULT_CONFIG_NAME = "titled"  # It's not mandatory to have a default configuration. Just use one if it make sense.
+    
     def _info(self):
         # TODO: This method specifies the datasets.DatasetInfo object which contains informations and typings for the dataset
         # if self.config.name == "config1": ... # This is the name of the configuration selected in BUILDER_CONFIGS above
@@ -136,13 +134,12 @@ class Wiki727k(datasets.GeneratorBasedBuilder):
                     datasets.Value("uint8")
                 ),
                 "labels": datasets.Sequence(
-                    datasets.ClassLabel(num_classes=2, names=['neg', 'pos'])
+                    datasets.ClassLabel(num_classes=2, names=['semantic-continuity', 'semantic-break'])
                 ),
             }
         )
         
-        # print(self.config)
-        if self.config.name == "untitled":
+        if self.config.drop_titles:
             features.pop("titles_mask")
             features.pop("levels")
 
@@ -192,18 +189,6 @@ class Wiki727k(datasets.GeneratorBasedBuilder):
     def _generate_examples(self, filepaths: list, split: str):            
         for filepath in filepaths:
             for doc in parse_split_files(filepath, 
-                                         drop_titles = (self.config.name == "untitled"), 
-                                         prepend_title_stack = False):
-                                        # drop_titles = self.config.drop_titles,
-                                        # prepend_title_stack = self.config.prepend_title_stack):
+                                        drop_titles = self.config.drop_titles,
+                                        prepend_title_stack = self.config.prepend_title_stack):
                 yield doc['id'], doc
-                
-                
-if __name__ == '__main__':
-    from datasets import load_dataset
-    
-    # Make sure to set num_proc to more than 1 to speed up the loading process
-    # Sharding is already enabled by the loading script
-    dataset = load_dataset('saeedabc/wiki727k', trust_remote_code=True, num_proc=8)
-    print(dataset)
-    print(dataset['train'][0])