Changed Dataset script to accommodate for new structuring

super_eurlex.py

@@ -55,8 +55,9 @@ _HOMEPAGE = ""
 # TODO: Add the licence for the dataset here if you can find it
 _LICENSE = ""
 
-AVAILABLE_LANGUAGES=['DE', 'EN']
+AVAILABLE_LANGUAGES=['DE']#, 'EN'
 SECTORS=['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'C', 'E']
+VERSIONS=[None, 'html', 'clean']
 
 # Features to override the standard most Features were scrapped as a sequence
 # of strings with only the following exceptions
@@ -67,16 +68,14 @@ FEATURES = {
     'text_html_raw': datasets.Value("string"),
 }
 FEATURES_IN_SECTOR={
-    '0':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form'],
-    '1':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form',
-         'subject_matter', 'current_consolidated_version',
+    '0':['form'],
+    '1':['form', 'subject_matter', 'current_consolidated_version',
          'harmonisation_of_customs_law_community_transit', 'harmonisation_of_customs_law_customs_territory',
          'harmonisation_of_customs_law_value_for_customs_purposes', 'directory_code', 'eurovoc',
          'customs_duties_community_tariff_quotas', 'customs_duties_community_tariff_quotas',
          'customs_duties_authorisation_to_defer_application_of_cct', 'harmonisation_of_customs_law_various',
          'customs_duties_suspensions'],
-    '2':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned',
-         'harmonisation_of_customs_law_origin_of_goods', 'form', 'directory_code',
+    '2':['harmonisation_of_customs_law_origin_of_goods', 'form', 'directory_code',
          'subject_matter', 'eurovoc', 'harmonisation_of_customs_law_community_transit',
          '02.40.10.20_customs_union_and_free_movement_of_goods_/_specific_customs_rules_/_movement_of_goods_/_extra-community_trade_efta_agreements',
          'current_consolidated_version',
@@ -100,8 +99,7 @@ FEATURES_IN_SECTOR={
          '13.30.10.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_motor_vehicles',
          'common_customs_tariff_temporary_importation'
          ],
-    '3':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'cct_derogations',
-         'directory_code', 'subject_matter','eurovoc', 'cct_franchise',
+    '3':['form', 'cct_derogations', 'directory_code', 'subject_matter','eurovoc', 'cct_franchise',
        'harmonisation_of_customs_law_various', 'latest_consolidated_version',
        '02.40.10.20_customs_union_and_free_movement_of_goods_/_specific_customs_rules_/_movement_of_goods_/_extra-community_trade_efta_agreements',
        'harmonisation_of_customs_law_community_transit',
@@ -152,8 +150,7 @@ FEATURES_IN_SECTOR={
        '13.20.30.00_industrial_policy_and_internal_market_/_industrial_policy_sectoral_operations_/_aeronautical_industry',
        '13.20.00.00_industrial_policy_and_internal_market_/_industrial_policy_sectoral_operations'
          ],
-    '4':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'eurovoc',
-       'subject_matter', 'current_consolidated_version', 'directory_code',
+    '4':['form', 'eurovoc', 'subject_matter', 'current_consolidated_version', 'directory_code',
        '13.30.10.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_motor_vehicles',
        '13.30.11.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_agricultural_and_forestry_tractors',
        '13.30.05.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_general,_programmes',
@@ -171,7 +168,7 @@ FEATURES_IN_SECTOR={
        '13.10.30.10_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_research_and_technological_development_/_general_principles',
        '13.10.20.00_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_programmes_and_statistics',
        '13.30.99.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_other_sectors_for_approximation_of_laws'],
-    '5':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'directory_code', 'subject_matter', 'eurovoc',
+    '5':['form', 'directory_code', 'subject_matter', 'eurovoc',
        '13.30.05.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_general,_programmes',
        '13.10.30.00_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_research_and_technological_development',
        '13.10.30.20_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_research_and_technological_development_/_research_sectors',
@@ -218,8 +215,7 @@ FEATURES_IN_SECTOR={
        'harmonisation_of_customs_law_value_for_customs_purposes',
        'harmonisation_of_customs_law_customs_territory',
        'current_consolidated_version'],
-    '6':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form',
-         'case-law_directory_code_before_lisbon', 'subject_matter', 'b-03.07.01_european_community_eec/ec_/_agriculture_/_structural_policy_/_structural_reform_of_agriculture_joint_action',
+    '6':['form', 'case-law_directory_code_before_lisbon', 'subject_matter', 'b-03.07.01_european_community_eec/ec_/_agriculture_/_structural_policy_/_structural_reform_of_agriculture_joint_action',
        'b-03.03.07_european_community_eec/ec_/_agriculture_/_common_organization_of_the_markets_principles_and_mechanisms_/_import_and_export_licences_and_advance-fixing_certificates',
        'b-03.03.06_european_community_eec/ec_/_agriculture_/_common_organization_of_the_markets_principles_and_mechanisms_/_export_refunds',
        'b-04.06.04.02_european_community_eec/ec_/_eec/ec_-_free_movement_of_persons_and_services_*_free_movement_of_persons_and_services_/_social_security_for_workers_/_social_security_for_workers_-_old_age_and_death_*_old_age_and_death_/_calculation_of_benefits_provisions_against_overlapping',
@@ -240,11 +236,10 @@ FEATURES_IN_SECTOR={
        '13.30.14.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_foodstuffs',
        '13.10.30.00_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_research_and_technological_development',
        'b-07.05.04.01_european_community_eec/ec_/_eec/ec_-_competition_*_competition_/_concentrations_between_undertakings_/_examination_by_the_commission_/_initiation_of_proceedings_notification_and_complaints'],
-    '7':['celex_id', 'text_cleaned', 'form', 'transposed_legal_acts'],#, 'text_html_raw', 'text_html_cleaned',
-    '8':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form',
-         'case-law_directory_code_before_lisbon', 'subject_matter',
+    '7':['form', 'transposed_legal_acts'],#, 'text_html_raw', 'text_html_cleaned',
+    '8':['form', 'case-law_directory_code_before_lisbon', 'subject_matter',
          'b-03.03_european_community_eec/ec_/_agriculture_/_common_organization_of_the_markets_principles_and_mechanisms'],
-    '9':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'eurovoc', 'subject_matter', 'directory_code',
+    '9':['form', 'eurovoc', 'subject_matter', 'directory_code',
        '13.10.30.10_industrial_policy_and_internal_market_/_industrial_policy_general,_programmes,_statistics_and_research_/_research_and_technological_development_/_general_principles',
        '13.30.99.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_other_sectors_for_approximation_of_laws',
        '13.30.05.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_general,_programmes',
@@ -285,8 +280,8 @@ FEATURES_IN_SECTOR={
        '13.20.10.00_industrial_policy_and_internal_market_/_industrial_policy_sectoral_operations_/_iron_and_steel_industry',
        '13.30.11.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_agricultural_and_forestry_tractors',
        'harmonisation_of_customs_law_warehouses,_free_zones'],
-    'C':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'eurovoc'],
-    'E':['celex_id', 'text_html_raw', 'text_html_cleaned', 'text_cleaned', 'form', 'directory_code',
+    'C':['form', 'eurovoc'],
+    'E':['form', 'directory_code',
         'subject_matter', 'eurovoc',
         '13.30.14.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_foodstuffs',
         '13.30.10.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_motor_vehicles',
@@ -295,28 +290,42 @@ FEATURES_IN_SECTOR={
         '13.20.60.00_industrial_policy_and_internal_market_/_industrial_policy_sectoral_operations_/_information_technology,_telecommunications_and_data-processing',
         '13.30.99.00_industrial_policy_and_internal_market_/_internal_market_approximation_of_laws_/_other_sectors_for_approximation_of_laws'],
 }
-AVAILABLE_FEATURES={sector: datasets.Features({feature:(FEATURES[feature] if feature in FEATURES else datasets.Sequence(datasets.Value("string"))) for feature in FEATURES_IN_SECTOR[sector]}) for sector in SECTORS}
+
+VERSION_FEATURES={
+    None: ['celex_id', 'text_cleaned'],
+    'clean': ['celex_id', 'text_cleaned'],
+    'html': ['celex_id', 'text_html_raw'],
+}
+
+available_features_tmp = []
+for version in VERSIONS:
+    v = '' if version is None else f"_{version}"
+    available_features_tmp.append(
+        {sector+v: datasets.Features({feature:(FEATURES[feature] if feature in FEATURES else datasets.Sequence(datasets.Value("string"))) for feature in VERSION_FEATURES[version] + FEATURES_IN_SECTOR[sector]}) for sector in SECTORS}
+    )
+# Combine Features Lists into single dictionary with the Features of each version of each sector
+AVAILABLE_FEATURES={k: v for d in available_features_tmp for k, v in d.items()}
 
 SECTOR_DESCRIPTIONS={
-    '0':"Consolidated acts ",
-    '1':"Treaties",
-    '2':"International agreements",
-    '3':"Legislation",
-    '4':"Complementary legislation",
-    '5':"Preparatory acts and working documents",
-    '6':"Case-law",
-    '7':"National transposition measures",
-    '8':"References to national case-law concerning EU law",
-    '9':"Parliamentary questions",
-    'C':"Other documents published in the Official Journal C series",
-    'E':"EFTA documents",
+    '0': "Consolidated acts ",
+    '1': "Treaties",
+    '2': "International agreements",
+    '3': "Legislation",
+    '4': "Complementary legislation",
+    '5': "Preparatory acts and working documents",
+    '6': "Case-law",
+    '7': "National transposition measures",
+    '8': "References to national case-law concerning EU law",
+    '9': "Parliamentary questions",
+    'C': "Other documents published in the Official Journal C series",
+    'E': "EFTA documents",
 }
 
 
 class SuperEurlexConfig(datasets.BuilderConfig):
     """BuilderConfig for SuperGLUE."""
 
-    def __init__(self, sector, language, features, citation, url, **kwargs):
+    def __init__(self, sector, language, feature_version, features, citation, url, **kwargs):
         """BuilderConfig for SuperGLUE.
 
         Args:
@@ -329,12 +338,13 @@ class SuperEurlexConfig(datasets.BuilderConfig):
         url: *string*, url for information about the data set.
         **kwargs: keyword arguments forwarded to super.
         """
-        name=sector+'.'+language
+        name=sector+'.'+language+('' if feature_version==None else f".{feature_version}")
         super().__init__(name=name, version=datasets.Version("0.1.0"), **kwargs)
         self.features = features
         self.language = language
         self.sector = sector
-        self.text_data_url = f"text_data/{language}/{sector}.parquet"
+        self.feature_version = str(feature_version)
+        self.text_data_url = f"text_data/{language}/{sector}_{'clean' if feature_version is None else feature_version}.parquet"
         self.meta_data_url = f"meta_data/{sector}.parquet"
         self.citation = citation
         self.url = url
@@ -357,18 +367,20 @@ class SuperEurlex(datasets.GeneratorBasedBuilder):
         SuperEurlexConfig(#version=VERSION,
                           sector=sect,
                           language=lang,
+                          feature_version=version,
                           description=SECTOR_DESCRIPTIONS[sect],
-                          features=AVAILABLE_FEATURES[sect],
+                          features=AVAILABLE_FEATURES[sect+("" if version is None else f"_{version}")],
                           citation=_CITATION,
                           url=_HOMEPAGE)
-        for lang in AVAILABLE_LANGUAGES for sect in SECTORS
+        for lang in AVAILABLE_LANGUAGES for sect in SECTORS for version in VERSIONS
         ]
 
     #DEFAULT_CONFIG_NAME = "3.DE"  # 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
-        features = AVAILABLE_FEATURES[self.config.sector]
+        v = "" if self.config.feature_version=="None" else "_"+self.config.feature_version
+        features = AVAILABLE_FEATURES[self.config.sector+v]
         info = datasets.DatasetInfo(
             # This is the description that will appear on the datasets page.
             description=_DESCRIPTION,
@@ -436,12 +448,15 @@ if __name__ == '__main__':
     print(sys.argv[0])
     for sector in SECTORS:
         for lang in AVAILABLE_LANGUAGES:
-            print(f'{sector}.{lang}')
-            try:
-                dataset = ds.load_dataset(sys.argv[0],f'{sector}.{lang}')
-                print(dataset)
-                print('\n')
-            except Exception as e:
-                # Handle the exception
-                print("An error occurred: " + e.with_traceback())
-                print(f"\n{sector}.{lang} Couldn't be loaded\n")
+            for version in VERSIONS:
+                v = "" if version is None else f".{version}"
+                print(f'{sector}.{lang}{v}')
+
+                try:
+                    dataset = ds.load_dataset(sys.argv[0],f'{sector}.{lang}{v}')
+                    print(dataset)
+                    print('\n')
+                except Exception as e:
+                    # Handle the exception
+                    print("An error occurred: " + str(e.with_traceback(None)))
+                    print(f"\n{sector}.{lang} Couldn't be loaded\n")