Update Housing_dataset.py

Housing_dataset.py

@@ -10,10 +10,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-# T0: Address all TODOs and remove all explanatory comments
-""" TO: Add a description here.
-"""
-
 
 import csv
 import json
@@ -23,19 +19,15 @@ import datasets
 import logging
 import pandas as pd
 
-# TODO: Add BibTeX citation
-# Find for instance the citation on arxiv or on the dataset repo/website
 _CITATION = """
 @InProceedings{huggingface:dataset,
-title = {A great new dataset},
-author={huggingface, Inc.
+title = {Seattle Housing Permits Dataset},
+author={Xinyan(Hathaway) Liu
 },
-year={2020}
+year={2024}
 }
 """
 
-# TODO: Add description of the dataset here
-# You can copy an official description
 _DESCRIPTION = """
 This typical dataset contains all the building permits issued or in progress 
 within the city of Seattle starting from 1990 to recent, and this dataset is 
@@ -43,22 +35,16 @@ still updating as time flows. Information includes permit records urls,
 detailed address, and building costs etc.
 """
 
-# TODO: Add a link to an official homepage for the dataset here
 _HOMEPAGE = "https://data.seattle.gov/Permitting/Building-Permits/76t5-zqzr/about_data"
 
-# TODO: Add the licence for the dataset here if you can find it
 _LICENSE = "	http://www.seattle.gov/sdci"
 
-# TODO: Add link to the official dataset URLs here
-# The HuggingFace Datasets library doesn't host the datasets but only points to the original files.
-# This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
 _URL = "https://data.seattle.gov/Permitting/Building-Permits/76t5-zqzr/about_data"
 _URLS = {
   "train": "https://github.com/HathawayLiu/Housing_dataset/raw/main/housing_train_dataset.csv",
   "test": "https://github.com/HathawayLiu/Housing_dataset/raw/main/housing_test_dataset.csv",
 }
 
-# TODO: Name of the dataset usually matches the script name with CamelCase instead of snake_case
 class HousingDataset(datasets.GeneratorBasedBuilder):
     """This dataset contains all building permits issued or in progress within 
     the city of Seattle. It includes the original columns in the datasets, with
@@ -74,33 +60,33 @@ class HousingDataset(datasets.GeneratorBasedBuilder):
           features=datasets.Features(
               {
                   # columns from original dataset
-                  "permitnum": datasets.Value("string"),
-                  "permitclass": datasets.Value("string"),
-                  "permitclassmapped": datasets.Value("string"),
-                  "permittypemapped": datasets.Value("string"),
-                  "permittypedesc": datasets.Value("string"),
-                  "description": datasets.Value("string"),
-                  "housingunits": datasets.Value("int64"),
-                  "housingunitsremoved": datasets.Value("int64"),
-                  "housingunitsadded": datasets.Value("int64"),
-                  "estprojectcost": datasets.Value("float32"),
-                  "applieddate": datasets.Value("string"),
-                  "issueddate": datasets.Value("string"),
-                  "expiresdate": datasets.Value("string"),
-                  "completeddate": datasets.Value("string"),
-                  "statuscurrent": datasets.Value("string"),
-                  "relatedmup": datasets.Value("string"),
-                  "originaladdress1": datasets.Value("string"),
-                  "originalcity": datasets.Value("string"),
-                  "originalstate": datasets.Value("string"),
-                  "originalzip": datasets.Value("int64"),
-                  "contractorcompanyname": datasets.Value("string"),
-                  "link": datasets.Value("string"),
-                  "latitude": datasets.Value("float32"),
-                  "longitude": datasets.Value("float32"),
-                  "location1": datasets.Value("string"),
+                  "PermitNum": datasets.Value("string"),
+                  "PermitClass": datasets.Value("string"),
+                  "PermitClassMapped": datasets.Value("string"),
+                  "PermitTypeMapped": datasets.Value("string"),
+                  "PermitTypeDesc": datasets.Value("string"),
+                  "Description": datasets.Value("string"),
+                  "HousingUnits": datasets.Value("int64"),
+                  "HousingUnitsRemoved": datasets.Value("int64"),
+                  "HousingUnitsAdded": datasets.Value("int64"),
+                  "EstProjectCost": datasets.Value("float32"),
+                  "AppliedDate": datasets.Value("string"),
+                  "IssuedDate": datasets.Value("string"),
+                  "ExpiresDate": datasets.Value("string"),
+                  "CompletedDate": datasets.Value("string"),
+                  "StatusCurrent": datasets.Value("string"),
+                  "RelatedMup": datasets.Value("string"),
+                  "OriginalAddress1": datasets.Value("string"),
+                  "OriginalCity": datasets.Value("string"),
+                  "OriginalState": datasets.Value("string"),
+                  "OriginalZip": datasets.Value("int64"),
+                  "ContractorCompanyName": datasets.Value("string"),
+                  "Link": datasets.Value("string"),
+                  "Latitude": datasets.Value("float32"),
+                  "Longitude": datasets.Value("float32"),
+                  "Location1": datasets.Value("string"),
                   # new added columns below
-                  "neighbordistrict": datasets.Value("string")
+                  "NeighborDistrict": datasets.Value("string")
               }
           ),
           # No default supervised_keys (as we have to pass both question
@@ -135,30 +121,30 @@ class HousingDataset(datasets.GeneratorBasedBuilder):
           # Iterating through each row to generate examples
           for index, row in housing_df.iterrows():
               yield index, {
-                  "permitnum": row.get("PermitNum", ""),
-                  "permitclass": row.get("PermitClass", ""),
-                  "permitclassmapped": row.get("PermitClassMapped", ""),
-                  "permittypemapped": row.get("PermitTypeMapped", ""),
-                  "permittypedesc": row.get("PermitTypeDesc", ""),
-                  "description": row.get("Description", ""),
-                  "housingunits": int(row.get("HousingUnits", "")),
-                  "housingunitsremoved": int(row.get("HousingUnitsRemoved", "")),
-                  "housingunitsadded": int(row.get("HousingUnitsAdded", "")),
-                  "estprojectcost": float(row.get("EstProjectCost", "")),
-                  "applieddate": str(row.get("AppliedDate", "")),
-                  "issueddate": str(row.get("IssuedDate", "")),
-                  "expiresdate": str(row.get("ExpiresDate", "")),
-                  "completeddate": str(row.get("CompletedDate", "")),
-                  "statuscurrent": row.get("StatusCurrent", ""),
-                  "relatedmup": row.get("RelatedMup", ""),
-                  "originaladdress1": row.get("OriginalAddress1", ""),
-                  "originalcity": row.get("OriginalCity", ""),
-                  "originalstate": row.get("OriginalState", ""),
-                  "originalzip": int(row.get("OriginalZip", "")),
-                  "contractorcompanyname": row.get("ContractorCompanyName", ""),
-                  "link": row.get("Link", ""),
-                  "latitude": row["Latitude"],
-                  "longitude": row["Longitude"],
-                  "location1": str(row["Latitude"]) + ", " + str(row["Longitude"]),
-                  "neighbordistrict": row.get("NeighborDistrict", "")
+                  "PermitNum": row.get("PermitNum", ""),
+                  "PermitClass": row.get("PermitClass", ""),
+                  "PermitClassMapped": row.get("PermitClassMapped", ""),
+                  "PermitTypeMapped": row.get("PermitTypeMapped", ""),
+                  "PermitTypeDesc": row.get("PermitTypeDesc", ""),
+                  "Description": row.get("Description", ""),
+                  "HousingUnits": int(row.get("HousingUnits", "")),
+                  "HousingUnitsRemoved": int(row.get("HousingUnitsRemoved", "")),
+                  "HousingUnitsAdded": int(row.get("HousingUnitsAdded", "")),
+                  "EstProjectCost": float(row.get("EstProjectCost", "")),
+                  "AppliedDate": str(row.get("AppliedDate", "")),
+                  "IssuedDate": str(row.get("IssuedDate", "")),
+                  "ExpiresDate": str(row.get("ExpiresDate", "")),
+                  "CompletedDate": str(row.get("CompletedDate", "")),
+                  "StatusCurrent": row.get("StatusCurrent", ""),
+                  "RelatedMup": row.get("RelatedMup", ""),
+                  "OriginalAddress1": row.get("OriginalAddress1", ""),
+                  "OriginalCity": row.get("OriginalCity", ""),
+                  "OriginalState": row.get("OriginalState", ""),
+                  "OriginalZip": int(row.get("OriginalZip", "")),
+                  "ContractorCompanyName": row.get("ContractorCompanyName", ""),
+                  "Link": row.get("Link", ""),
+                  "Latitude": row["Latitude"],
+                  "Longitude": row["Longitude"],
+                  "Location1": str(row["Latitude"]) + ", " + str(row["Longitude"]),
+                  "NeighborDistrict": row.get("NeighborDistrict", "")
               }