Update README.md

README.md

@@ -11,61 +11,102 @@ size_categories:
 
 # Dataset Card for Housing_Dataset
 
-<!-- Provide a quick summary of the dataset. -->
-
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+This typical dataset contains all the building permits issued or in progress 
+within the city of Seattle starting from 2000 to recent, and this dataset is 
+still updating as time flows. Information includes permit records urls, 
+detailed address, and building costs etc., which will be presented in the `housing_dataset.py`
+file and the following description
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
-
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+This [**Seattle Housing permits dataset**](https://data.seattle.gov/Permitting/Building-Permits/76t5-zqzr/about_data) 
+is authorized by Seattle Government and could be found in Seattle Government open data portal. 
+The Building Permits dataset from the City of Seattle's Open Data portal provides comprehensive information about building permits issued or currently in progress within Seattle. 
+This dataset, which dates back to 1990 and continues to be updated, includes a wide range of details such as permit numbers, types, descriptions, 
+estimated project costs, and related contractor information could be found in the .csv table in the official website, which in total contains 25 columns.
+Moreover, Seattle is divided in 13 Neighborhood District. Based on the [Seattle Neighborhood District GeoJson File](https://data-seattlecitygis.opendata.arcgis.com/datasets/SeattleCityGIS::neighborhood-map-atlas-districts/about) found on Seattle government website, 
+there will a new column created, namely NeighborhoodDistrict. With the provided GeoJson file, every housing will be assigned to the corresponding
+neighborhood district using the `Latitude` and `Longitude` columns in the csv for future usage.
 
-### Dataset Sources [optional]
+- **Curated by:** [Seattle Government Open data portal](https://data.seattle.gov/)
+- **Language(s) (NLP):** [English]
+- **License:** [Public Domain by Seattle Government](http://www.seattle.gov/sdci)
 
-<!-- Provide the basic links for the dataset. -->
+### Dataset Sources
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Offical Website:** [https://data.seattle.gov/]
+- **Repository for Cleaned Dataset:** [https://github.com/HathawayLiu/Housing_dataset]
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+The Building Permits dataset from the City of Seattle is intended for use in various urban development and research applications. 
+It can assist in understanding building trends in Seattle, aid city planning, and support academic research on urban development. 
+The dataset is also a valuable tool for residents and businesses to stay informed about construction activities and regulations in the city.
+Specifically for residents, this dataset provides starting information for choosing future housing by looking at housing cost, neighborhood district,
+and other information in the dataset.
+Additionally, it supports transparency and public engagement in city planning processes. 
 
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+The Building Permits dataset from the City of Seattle is suitable for several use cases:
+- **Urban Planning and Development:** Planners and developers can analyze trends in building permits to inform city development strategies and infrastructure planning.
+- **Academic Research:** Researchers in urban studies, economics, and social sciences can use the data for studies on urban growth, housing, and economic activity.
+- **Real Estate Analysis:** Real estate professionals can assess building activities in neighborhoods for market analysis and investment decisions.
+- **Public Awareness:** The general public can use this data to stay informed about construction activities and developmental changes in their community.
+- **Government and Policy Making:** Local government officials can utilize this data to make informed decisions on housing policies, zoning laws,
+  and community development projects.
+- **Residents housing choice:** Residents could access this dataset for relevant information for their future housing choice.
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+The Building Permits dataset from the City of Seattle should not be used for purposes that could infringe on privacy or for activities that are not in line 
+with ethical standards. This includes any form of misuse or malicious use such as targeting individuals or businesses based on the information provided in the dataset. 
+Additionally, the dataset may not be suitable for applications requiring highly specialized or non-public information about building structures, 
+as it primarily contains permit-related data. 
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
+The cleaned and modified full dataset[`Building_Permits_Cleaned.csv`], the splited train[`housing_train_dataset.csv`] and test[`housing_test_dataset.csv`] dataset, 
+and the script to achieve that are provided in the following Github Repo: [https://github.com/HathawayLiu/Housing_dataset]
+
+The cleaned dataset in total contains 26 columns:
+- **`PermitNum`(string):** The tracking number used to refer to this permit in SDCI's tracking system.
+- **`PermitClass`(string):** The permit class tells you the type of project.
+- **`PermitClassMapped`(string):** A description of whether the permit is for a residential or non-residential project.
+- **`PermitTypeMapped`(string):** The permit type by category, such as building, demolition, roofing, grading, and environmentally critical areas.
+- **`PermitTypeDesc`(string):** Additional information about the type of permit. For example, whether it is an addition/alternation or a new project.
+- **`Description`(string):** A brief description of the work that will be done under this permit. This description is subject to change before SDCI issues the permit. The description is generally more stable if we have issued the permit. Very long descriptions have been truncated.
+- **`HousingUnits`(int):** The number of housing units included at the beginning of the project.
+- **`HousingUnitsRemoved`(int)** The number of housing units removed during the project.
+- **`HousingUnitsAdded`(int):** The number of housing units added during the project.
+- **`EstProjectCost`(float):** The estimated project cost of the work being proposed is based on fair market value (parts plus labor). The estimated cost (if any) represents the best available information to date, and is subject to change if the project is modified. We do not collect the estimated project cost for all permit types.
+- **`AppliedDate`(string):** The date SDCI accepted the application as a complete submittal.
+- **`IssuedDate`(string):** The date SDCI issued the permit. If there is an Application Date but no Issue Date, this generally means the application is still under review.
+- **`ExpiresDate`(string):** The date the application is due to expire. Generally, this is the date by which work is supposed to be completed (barring renewals or further extensions). If there is not an Expiration Date, this generally means the permit has not been issued.
+- **`CompletedDate`(string):** The date the permit had all its inspections completed. If there is an Issue Date but not a Completed Date, this generally means the permit is still under inspection.
+- **`RelatedMup`(string):** The land use permit that is related to this building permit, if there is one.
+- **`OriginalAddress1`(string):** The street name and number of the project.
+- **`OriginalCity`(string):** The city for the project's address.
+- **`OriginalState`(string):** The state for the project's address.
+- **`OriginalZip`(string):** The Zip code for the project's address.
+- **`ContractorCompanyName`(string):** The contractor(s) associated with this permit.
+- **`Link`(string):** A link to view full details and current status information about this permit at SDCI's website.
+- **`Latitude`(float):** Latitude of the worksite where permit activity occurs. May be missing for a small number of permits considered "unaddressable."
+- **`Longitude`(float):** Longitude of the worksite where permit activity occurs. May be missing for a small number of permits considered "unaddressable."
+- **`Location1`(string):** The latitude and longitude location for mapping purposes.
+- (New added column)**`NeighborhoodDistrict`(string):** The district that the housing belongs to according to location
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
+The Building Permits dataset from the City of Seattle was created to foster transparency, public awareness, and engagement in the city's urban development processes.
+It provides residents, professionals, and researchers with detailed information about building activities, facilitating informed decision-making and community involvement in city planning and development. 
+Regarding the importance fo 13 neighborhood districts in Seattle, the new added columns for corresponding neighborhood district gives chance for residents and government
+to investigate the building activities and life quality in the aspect of different neighborhood districts.
+The dataset supports the city's commitment to open data and the promotion of data-driven insights for improving urban infrastructure and living conditions.
 
 ### Source Data
 
@@ -79,43 +120,35 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 #### Who are the source data producers?
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
+The Building Permits dataset is originally created and maintained by the City of Seattle, specifically by its Department of Construction and Inspections. 
+This department is responsible for overseeing building and land use in Seattle, ensuring safety and compliance with city codes. 
+The dataset reflects the department's ongoing work in managing and documenting building permits issued in the city. 
+For detailed information, visit the [Seattle Department of Construction & Inspections](https://www.seattle.gov/sdci).
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The Building Permits dataset from the City of Seattle has both technical and sociotechnical limitations:
+1. **Technical Limitations**:
+   - **Data Completeness**: Not all building permits may be captured, especially older records. Data for specific columns like `IssuedDate`, `CompletedDate`, `AppliedDate`,
+     `RelatedMup`, and etc. contains lots of missing values.
+   - **Data Accuracy**: There may be errors or inconsistencies in the data, especially in historical records.
+   - **Timeliness**: The dataset might not be updated in real-time, causing delays in reflecting the most current information.
+
+2. **Sociotechnical Limitations**:
+   - **Privacy Concerns**: Detailed permit data could potentially be used to infer private information about property owners or residents.
+   - **Bias in Planning Decisions**: The data might be used to reinforce existing biases in urban planning, affecting marginalized communities.
+   - **Dependence on Technical Proficiency**: The dataset's utility is limited by the user's ability to interpret and analyze the data effectively.
+3. **Bias**: The dataset reflects only permitted construction, not all building activities. This can bias analyses towards formal, recorded developments, overlooking informal or unpermitted construction.
+4. **Risk**: Misuse can occur if data is used to unfairly target specific neighborhoods or communities for enforcement or political reasons.
+These limitations should be considered when using this dataset for research, policy-making, or urban planning. 
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+To address the bias and limitations above, users should intake the following recommendations:
+- **Cross-Verification**: Use supplementary data sources for a more comprehensive view.
+- **Privacy and Ethical Use**: Handle data responsibly, respecting privacy and avoiding discriminatory practices.
+- **Data Cleaning and Validation**: Regularly update and clean the dataset to maintain accuracy and reliability.
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
 
 **BibTeX:**