cloderic commited on
Commit
b306b77
1 Parent(s): bf6c2b2

Add processed metadata

Browse files
AmesHousing.csv CHANGED
@@ -1,4 +1,4 @@
1
- order,pid,ms_subclass,ms_zoning,lot_frontage,lot_area,street,alley,lot_shape,land_contour,utilities,lot_config,land_slope,neighborhood,condition_1,condition_2,bldg_type,house_style,overall_qual,overall_cond,year_built,year_remod/add,roof_style,roof_matl,exterior_1st,exterior_2nd,mas_vnr_type,mas_vnr_area,exter_qual,exter_cond,foundation,bsmt_qual,bsmt_cond,bsmt_exposure,bsmtfin_type_1,bsmtfin_sf_1,bsmtfin_type_2,bsmtfin_sf_2,bsmt_unf_sf,total_bsmt_sf,heating,heating_qc,central_air,electrical,1st_flr_sf,2nd_flr_sf,low_qual_fin_sf,gr_liv_area,bsmt_full_bath,bsmt_half_bath,full_bath,half_bath,bedroom_abvgr,kitchen_abvgr,kitchen_qual,totrms_abvgrd,functional,fireplaces,fireplace_qu,garage_type,garage_yr_blt,garage_finish,garage_cars,garage_area,garage_qual,garage_cond,paved_drive,wood_deck_sf,open_porch_sf,enclosed_porch,3ssn_porch,screen_porch,pool_area,pool_qc,fence,misc_feature,misc_val,mo_sold,yr_sold,sale_type,sale_condition,saleprice
2
  1,526301100,20,RL,141.0,31770,Pave,,IR1,Lvl,AllPub,Corner,Gtl,NAmes,Norm,Norm,1Fam,1Story,6,5,1960,1960,Hip,CompShg,BrkFace,Plywood,Stone,112.0,TA,TA,CBlock,TA,Gd,Gd,BLQ,639.0,Unf,0.0,441.0,1080.0,GasA,Fa,Y,SBrkr,1656,0,0,1656,1.0,0.0,1,0,3,1,TA,7,Typ,2,Gd,Attchd,1960.0,Fin,2.0,528.0,TA,TA,P,210,62,0,0,0,0,,,,0,5,2010,WD ,Normal,215000
3
  2,526350040,20,RH,80.0,11622,Pave,,Reg,Lvl,AllPub,Inside,Gtl,NAmes,Feedr,Norm,1Fam,1Story,5,6,1961,1961,Gable,CompShg,VinylSd,VinylSd,,0.0,TA,TA,CBlock,TA,TA,No,Rec,468.0,LwQ,144.0,270.0,882.0,GasA,TA,Y,SBrkr,896,0,0,896,0.0,0.0,1,0,2,1,TA,5,Typ,0,,Attchd,1961.0,Unf,1.0,730.0,TA,TA,Y,140,0,0,0,120,0,,MnPrv,,0,6,2010,WD ,Normal,105000
4
  3,526351010,20,RL,81.0,14267,Pave,,IR1,Lvl,AllPub,Corner,Gtl,NAmes,Norm,Norm,1Fam,1Story,6,6,1958,1958,Hip,CompShg,Wd Sdng,Wd Sdng,BrkFace,108.0,TA,TA,CBlock,TA,TA,No,ALQ,923.0,Unf,0.0,406.0,1329.0,GasA,TA,Y,SBrkr,1329,0,0,1329,0.0,0.0,1,1,3,1,Gd,6,Typ,0,,Attchd,1958.0,Unf,1.0,312.0,TA,TA,Y,393,36,0,0,0,0,,,Gar2,12500,6,2010,WD ,Normal,172000
 
1
+ order,pid,ms_subclass,ms_zoning,lot_frontage,lot_area,street,alley,lot_shape,land_contour,utilities,lot_config,land_slope,neighborhood,condition_1,condition_2,bldg_type,house_style,overall_qual,overall_cond,year_built,year_remod_add,roof_style,roof_matl,exterior_1st,exterior_2nd,mas_vnr_type,mas_vnr_area,exter_qual,exter_cond,foundation,bsmt_qual,bsmt_cond,bsmt_exposure,bsmtfin_type_1,bsmtfin_sf_1,bsmtfin_type_2,bsmtfin_sf_2,bsmt_unf_sf,total_bsmt_sf,heating,heating_qc,central_air,electrical,1st_flr_sf,2nd_flr_sf,low_qual_fin_sf,gr_liv_area,bsmt_full_bath,bsmt_half_bath,full_bath,half_bath,bedroom_abvgr,kitchen_abvgr,kitchen_qual,totrms_abvgrd,functional,fireplaces,fireplace_qu,garage_type,garage_yr_blt,garage_finish,garage_cars,garage_area,garage_qual,garage_cond,paved_drive,wood_deck_sf,open_porch_sf,enclosed_porch,3ssn_porch,screen_porch,pool_area,pool_qc,fence,misc_feature,misc_val,mo_sold,yr_sold,sale_type,sale_condition,saleprice
2
  1,526301100,20,RL,141.0,31770,Pave,,IR1,Lvl,AllPub,Corner,Gtl,NAmes,Norm,Norm,1Fam,1Story,6,5,1960,1960,Hip,CompShg,BrkFace,Plywood,Stone,112.0,TA,TA,CBlock,TA,Gd,Gd,BLQ,639.0,Unf,0.0,441.0,1080.0,GasA,Fa,Y,SBrkr,1656,0,0,1656,1.0,0.0,1,0,3,1,TA,7,Typ,2,Gd,Attchd,1960.0,Fin,2.0,528.0,TA,TA,P,210,62,0,0,0,0,,,,0,5,2010,WD ,Normal,215000
3
  2,526350040,20,RH,80.0,11622,Pave,,Reg,Lvl,AllPub,Inside,Gtl,NAmes,Feedr,Norm,1Fam,1Story,5,6,1961,1961,Gable,CompShg,VinylSd,VinylSd,,0.0,TA,TA,CBlock,TA,TA,No,Rec,468.0,LwQ,144.0,270.0,882.0,GasA,TA,Y,SBrkr,896,0,0,896,0.0,0.0,1,0,2,1,TA,5,Typ,0,,Attchd,1961.0,Unf,1.0,730.0,TA,TA,Y,140,0,0,0,120,0,,MnPrv,,0,6,2010,WD ,Normal,105000
4
  3,526351010,20,RL,81.0,14267,Pave,,IR1,Lvl,AllPub,Corner,Gtl,NAmes,Norm,Norm,1Fam,1Story,6,6,1958,1958,Hip,CompShg,Wd Sdng,Wd Sdng,BrkFace,108.0,TA,TA,CBlock,TA,TA,No,ALQ,923.0,Unf,0.0,406.0,1329.0,GasA,TA,Y,SBrkr,1329,0,0,1329,0.0,0.0,1,1,3,1,Gd,6,Typ,0,,Attchd,1958.0,Unf,1.0,312.0,TA,TA,Y,393,36,0,0,0,0,,,Gar2,12500,6,2010,WD ,Normal,172000
README.md CHANGED
@@ -13,6 +13,8 @@ configs:
13
  data_files: "AmesHousing.csv"
14
  default: true
15
  sep: ","
 
 
16
  ---
17
 
18
  # Dataset Card for 'Ames Iowa: Alternative to the Boston Housing Data Set'
@@ -33,7 +35,7 @@ The dataset was originally published by Dean De Cock in [Ames, Iowa: Alternative
33
  - **Curated by:** Dean De Cock, Truman State University
34
  - **License:** Unknown
35
 
36
- Full description of the dataset is in [./DataDocumentation.txt](./DataDocumentation.txt)
37
 
38
  The main dataset file is [`AmesHousing.csv`](./AmesHousing.csv) is the result of a simple preprocessing of the original file, the preprocessing script is in [`./preprocessing/preprocess.py`](preprocessing/preprocess.py).
39
 
 
13
  data_files: "AmesHousing.csv"
14
  default: true
15
  sep: ","
16
+ - config_name: metadata
17
+ data_files: "metadata.json"
18
  ---
19
 
20
  # Dataset Card for 'Ames Iowa: Alternative to the Boston Housing Data Set'
 
35
  - **Curated by:** Dean De Cock, Truman State University
36
  - **License:** Unknown
37
 
38
+ Full description of the dataset is in [`./originals/DataDocumentation.txt`](./originals/DataDocumentation.txt), structured metadata was extracted manually in [`./metadata.json`](./metadata.json`).
39
 
40
  The main dataset file is [`AmesHousing.csv`](./AmesHousing.csv) is the result of a simple preprocessing of the original file, the preprocessing script is in [`./preprocessing/preprocess.py`](preprocessing/preprocess.py).
41
 
metadata.json ADDED
@@ -0,0 +1,703 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "variable": "order",
4
+ "description": "Observation number",
5
+ },
6
+ {
7
+ "variable": "pid",
8
+ "description": "Parcel identification number - can be used with city web site for parcel review.",
9
+ },
10
+ {
11
+ "variable": "ms_suclass",
12
+ "description": "Identifies the type of dwelling involved in the sale.",
13
+ "values":
14
+ {
15
+ "20": "1-STORY 1946 & NEWER ALL STYLES",
16
+ "30": "1-STORY 1945 & OLDER",
17
+ "40": "1-STORY W/FINISHED ATTIC ALL AGES",
18
+ "45": "1-1/2 STORY - UNFINISHED ALL AGES",
19
+ "50": "1-1/2 STORY FINISHED ALL AGES",
20
+ "60": "2-STORY 1946 & NEWER",
21
+ "70": "2-STORY 1945 & OLDER",
22
+ "75": "2-1/2 STORY ALL AGES",
23
+ "80": "SPLIT OR MULTI-LEVEL",
24
+ "85": "SPLIT FOYER",
25
+ "90": "DUPLEX - ALL STYLES AND AGES",
26
+ "120": "1-STORY PUD (Planned Unit Development) - 1946 & NEWER",
27
+ "150": "1-1/2 STORY PUD - ALL AGES",
28
+ "160": "2-STORY PUD - 1946 & NEWER",
29
+ "180": "PUD - MULTILEVEL - INCL SPLIT LEV/FOYER",
30
+ "190": "2 FAMILY CONVERSION - ALL STYLES AND AGES"
31
+ }
32
+ },
33
+ {
34
+ "variable": "ms_zoning",
35
+ "description": "Identifies the general zoning classification of the sale.",
36
+ "values":
37
+ {
38
+ "A": "Agriculture",
39
+ "C": "Commercial",
40
+ "FV": "Floating Village Residential",
41
+ "I": "Industrial",
42
+ "RH": "Residential High Density",
43
+ "RL": "Residential Low Density",
44
+ "RP": "Residential Low Density Park",
45
+ "RM": "Residential Medium Density"
46
+ }
47
+ },
48
+ {
49
+ "variable": "lot_frontage",
50
+ "description": "Linear feet of street connected to property"
51
+ },
52
+ { "variable": "lot_area", "description": "Lot size in square feet" },
53
+ {
54
+ "variable": "street",
55
+ "description": "Type of road access to property",
56
+ "values": { "Grvl": "Gravel", "Pave": "Paved" }
57
+ },
58
+ {
59
+ "variable": "alley",
60
+ "description": "Type of alley access to property",
61
+ "values": { "Grvl": "Gravel", "Pave": "Paved", "NA": "No alley access" }
62
+ },
63
+ {
64
+ "variable": "lot_shape",
65
+ "description": "General shape of property",
66
+ "values":
67
+ {
68
+ "Reg": "Regular",
69
+ "IR1": "Slightly irregular",
70
+ "IR2": "Moderately Irregular",
71
+ "IR3": "Irregular"
72
+ }
73
+ },
74
+ {
75
+ "variable": "land_contour",
76
+ "description": "Flatness of the property",
77
+ "values":
78
+ {
79
+ "Lvl": "Near Flat/Level",
80
+ "Bnk": "Banked - Quick and significant rise from street grade to building",
81
+ "HLS": "Hillside - Significant slope from side to side",
82
+ "Low": "Depression"
83
+ }
84
+ },
85
+ {
86
+ "variable": "utilities",
87
+ "description": "Type of utilities available",
88
+ "values":
89
+ {
90
+ "AllPub": "All public Utilities (E,G,W,& S)",
91
+ "NoSewr": "Electricity, Gas, and Water (Septic Tank)",
92
+ "NoSeWa": "Electricity and Gas Only",
93
+ "ELO": "Electricity only"
94
+ }
95
+ },
96
+ {
97
+ "variable": "lot_config",
98
+ "description": "Lot configuration",
99
+ "values":
100
+ {
101
+ "Inside": "Inside lot",
102
+ "Corner": "Corner lot",
103
+ "CulDSac": "Cul-de-sac",
104
+ "FR2": "Frontage on 2 sides of property",
105
+ "FR3": "Frontage on 3 sides of property"
106
+ }
107
+ },
108
+ {
109
+ "variable": "land_slope",
110
+ "description": "Slope of property",
111
+ "values":
112
+ { "Gtl": "Gentle slope", "Mod": "Moderate Slope", "Sev": "Severe Slope" }
113
+ },
114
+ {
115
+ "variable": "neighborhood",
116
+ "description": "Physical locations within Ames city limits",
117
+ "values":
118
+ {
119
+ "Blmngtn": "Bloomington Heights",
120
+ "Blueste": "Bluestem",
121
+ "BrDale": "Briardale",
122
+ "BrkSide": "Brookside",
123
+ "ClearCr": "Clear Creek",
124
+ "CollgCr": "College Creek",
125
+ "Crawfor": "Crawford",
126
+ "Edwards": "Edwards",
127
+ "Gilbert": "Gilbert",
128
+ "IDOTRR": "Iowa DOT and Rail Road",
129
+ "MeadowV": "Meadow Village",
130
+ "Mitchel": "Mitchell",
131
+ "NAmes": "North Ames",
132
+ "NoRidge": "Northridge",
133
+ "NPkVill": "Northpark Villa",
134
+ "NridgHt": "Northridge Heights",
135
+ "NWAmes": "Northwest Ames",
136
+ "OldTown": "Old Town",
137
+ "SWISU": "South & West of Iowa State University",
138
+ "Sawyer": "Sawyer",
139
+ "SawyerW": "Sawyer West",
140
+ "Somerst": "Somerset",
141
+ "StoneBr": "Stone Brook",
142
+ "Timber": "Timberland",
143
+ "Veenker": "Veenker"
144
+ }
145
+ },
146
+ {
147
+ "variable": "condition_1",
148
+ "description": "Proximity to various conditions",
149
+ "values":
150
+ {
151
+ "Artery": "Adjacent to arterial street",
152
+ "Feedr": "Adjacent to feeder street",
153
+ "Norm": "Normal",
154
+ "RRNn": "Within 200' of North-South Railroad",
155
+ "RRAn": "Adjacent to North-South Railroad",
156
+ "PosN": "Near positive off-site feature--park, greenbelt, etc.",
157
+ "PosA": "Adjacent to postive off-site feature",
158
+ "RRNe": "Within 200' of East-West Railroad",
159
+ "RRAe": "Adjacent to East-West Railroad"
160
+ }
161
+ },
162
+ {
163
+ "variable": "condition_2",
164
+ "description": "Proximity to various conditions (if more than one is present)",
165
+ "values":
166
+ {
167
+ "Artery": "Adjacent to arterial street",
168
+ "Feedr": "Adjacent to feeder street",
169
+ "Norm": "Normal",
170
+ "RRNn": "Within 200' of North-South Railroad",
171
+ "RRAn": "Adjacent to North-South Railroad",
172
+ "PosN": "Near positive off-site feature--park, greenbelt, etc.",
173
+ "PosA": "Adjacent to postive off-site feature",
174
+ "RRNe": "Within 200' of East-West Railroad",
175
+ "RRAe": "Adjacent to East-West Railroad"
176
+ }
177
+ },
178
+ {
179
+ "variable": "bldg_type",
180
+ "description": "Type of dwelling",
181
+ "values":
182
+ {
183
+ "1Fam": "Single-family Detached",
184
+ "2FmCon": "Two-family Conversion; originally built as one-family dwelling",
185
+ "Duplx": "Duplex",
186
+ "TwnhsE": "Townhouse End Unit",
187
+ "TwnhsI": "Townhouse Inside Unit"
188
+ }
189
+ },
190
+ {
191
+ "variable": "house_style",
192
+ "description": "Style of dwelling",
193
+ "values":
194
+ {
195
+ "1Story": "One story",
196
+ "1.5Fin": "One and one-half story, 2nd level finished",
197
+ "1.5Unf": "One and one-half story, 2nd level unfinished",
198
+ "2Story": "Two story",
199
+ "2.5Fin": "Two and one-half story, 2nd level finished",
200
+ "2.5Unf": "Two and one-half story, 2nd level unfinished",
201
+ "SFoyer": "Split Foyer",
202
+ "SLvl": "Split Level"
203
+ }
204
+ },
205
+ {
206
+ "variable": "overall_qual",
207
+ "description": "Rates the overall material and finish of the house",
208
+ "values":
209
+ {
210
+ "1": "Very Poor",
211
+ "2": "Poor",
212
+ "3": "Fair",
213
+ "4": "Below Average",
214
+ "5": "Average",
215
+ "6": "Above Average",
216
+ "7": "Good",
217
+ "8": "Very Good",
218
+ "9": "Excellent",
219
+ "10": "Very Excellent"
220
+ }
221
+ },
222
+ {
223
+ "variable": "overall_cond",
224
+ "description": "Rates the overall condition of the house",
225
+ "values":
226
+ {
227
+ "1": "Very Poor",
228
+ "2": "Poor",
229
+ "3": "Fair",
230
+ "4": "Below Average",
231
+ "5": "Average",
232
+ "6": "Above Average",
233
+ "7": "Good",
234
+ "8": "Very Good",
235
+ "9": "Excellent",
236
+ "10": "Very Excellent"
237
+ }
238
+ },
239
+ { "variable": "year_built", "description": "Original construction date" },
240
+ {
241
+ "variable": "year_remod_add",
242
+ "description": "Remodel date (same as construction date if no remodeling or additions)"
243
+ },
244
+ {
245
+ "variable": "roof_style",
246
+ "description": "Type of roof",
247
+ "values":
248
+ {
249
+ "Flat": "Flat",
250
+ "Gable": "Gable",
251
+ "Gambrel": "Gabrel (Barn)",
252
+ "Hip": "Hip",
253
+ "Mansard": "Mansard",
254
+ "Shed": "Shed"
255
+ }
256
+ },
257
+ {
258
+ "variable": "roof_matl",
259
+ "description": "Roof material",
260
+ "values":
261
+ {
262
+ "ClyTile": "Clay or Tile",
263
+ "CompShg": "Standard (Composite) Shingle",
264
+ "Membran": "Membrane",
265
+ "Metal": "Metal",
266
+ "Roll": "Roll",
267
+ "Tar&Grv": "Gravel & Tar",
268
+ "WdShake": "Wood Shakes",
269
+ "WdShngl": "Wood Shingles"
270
+ }
271
+ },
272
+ {
273
+ "variable": "exterior_1st",
274
+ "description": "Exterior covering on house",
275
+ "values":
276
+ {
277
+ "AsbShng": "Asbestos Shingles",
278
+ "AsphShn": "Asphalt Shingles",
279
+ "BrkComm": "Brick Common",
280
+ "BrkFace": "Brick Face",
281
+ "CBlock": "Cinder Block",
282
+ "CemntBd": "Cement Board",
283
+ "HdBoard": "Hard Board",
284
+ "ImStucc": "Imitation Stucco",
285
+ "MetalSd": "Metal Siding",
286
+ "Other": "Other",
287
+ "Plywood": "Plywood",
288
+ "PreCast": "PreCast",
289
+ "Stone": "Stone",
290
+ "Stucco": "Stucco",
291
+ "VinylSd": "Vinyl Siding",
292
+ "Wd": "Sdng\tWood Siding",
293
+ "WdShing": "Wood Shingles"
294
+ }
295
+ },
296
+ {
297
+ "variable": "exterior_2nd",
298
+ "description": "Exterior covering on house (if more than one material)",
299
+ "values":
300
+ {
301
+ "AsbShng": "Asbestos Shingles",
302
+ "AsphShn": "Asphalt Shingles",
303
+ "BrkComm": "Brick Common",
304
+ "BrkFace": "Brick Face",
305
+ "CBlock": "Cinder Block",
306
+ "CemntBd": "Cement Board",
307
+ "HdBoard": "Hard Board",
308
+ "ImStucc": "Imitation Stucco",
309
+ "MetalSd": "Metal Siding",
310
+ "Other": "Other",
311
+ "Plywood": "Plywood",
312
+ "PreCast": "PreCast",
313
+ "Stone": "Stone",
314
+ "Stucco": "Stucco",
315
+ "VinylSd": "Vinyl Siding",
316
+ "Wd": "Sdng\tWood Siding",
317
+ "WdShing": "Wood Shingles"
318
+ }
319
+ },
320
+ {
321
+ "variable": "mas_vnr_type",
322
+ "description": "Masonry veneer type",
323
+ "values":
324
+ {
325
+ "BrkCmn": "Brick Common",
326
+ "BrkFace": "Brick Face",
327
+ "CBlock": "Cinder Block",
328
+ "None": "None",
329
+ "Stone": "Stone"
330
+ }
331
+ },
332
+ {
333
+ "variable": "mas_vnr_area",
334
+ "description": "Masonry veneer area in square feet"
335
+ },
336
+ {
337
+ "variable": "exter_qual",
338
+ "description": "Evaluates the quality of the material on the exterior",
339
+ "values":
340
+ {
341
+ "Ex": "Excellent",
342
+ "Gd": "Good",
343
+ "TA": "Average/Typical",
344
+ "Fa": "Fair",
345
+ "Po": "Poor"
346
+ }
347
+ },
348
+ {
349
+ "variable": "exter_cond",
350
+ "description": "Evaluates the present condition of the material on the exterior",
351
+ "values":
352
+ {
353
+ "Ex": "Excellent",
354
+ "Gd": "Good",
355
+ "TA": "Average/Typical",
356
+ "Fa": "Fair",
357
+ "Po": "Poor"
358
+ }
359
+ },
360
+ {
361
+ "variable": "foundation",
362
+ "description": "Type of foundation",
363
+ "values":
364
+ {
365
+ "BrkTil": "Brick & Tile",
366
+ "CBlock": "Cinder Block",
367
+ "PConc": "Poured Contrete",
368
+ "Slab": "Slab",
369
+ "Stone": "Stone",
370
+ "Wood": "Wood"
371
+ }
372
+ },
373
+ {
374
+ "variable": "bsmt_qual",
375
+ "description": "Evaluates the height of the basement",
376
+ "values":
377
+ {
378
+ "Ex": "Excellent (100+ inches)",
379
+ "Gd": "Good (90-99 inches)",
380
+ "TA": "Typical (80-89 inches)",
381
+ "Fa": "Fair (70-79 inches)",
382
+ "Po": "Poor (<70 inches",
383
+ "NA": "No Basement"
384
+ }
385
+ },
386
+ {
387
+ "variable": "bsmt_cond",
388
+ "description": "Evaluates the general condition of the basement",
389
+ "values":
390
+ {
391
+ "Ex": "Excellent",
392
+ "Gd": "Good",
393
+ "TA": "Typical - slight dampness allowed",
394
+ "Fa": "Fair - dampness or some cracking or settling",
395
+ "Po": "Poor - Severe cracking, settling, or wetness",
396
+ "NA": "No Basement"
397
+ }
398
+ },
399
+ {
400
+ "variable": "bsmt_exposure",
401
+ "description": "Refers to walkout or garden level walls",
402
+ "values":
403
+ {
404
+ "Gd": "Good Exposure",
405
+ "Av": "Average Exposure (split levels or foyers typically score average or above)",
406
+ "Mn": "Mimimum Exposure",
407
+ "No": "No Exposure",
408
+ "NA": "No Basement"
409
+ }
410
+ },
411
+ {
412
+ "variable": "bsmtfin_type_1",
413
+ "description": "Rating of basement finished area",
414
+ "values":
415
+ {
416
+ "GLQ": "Good Living Quarters",
417
+ "ALQ": "Average Living Quarters",
418
+ "BLQ": "Below Average Living Quarters",
419
+ "Rec": "Average Rec Room",
420
+ "LwQ": "Low Quality",
421
+ "Unf": "Unfinshed",
422
+ "NA": "No Basement"
423
+ }
424
+ },
425
+ { "variable": "bsmtfin_sf_1", "description": "Type 1 finished square feet" },
426
+ {
427
+ "variable": "bsmtfin_type_2",
428
+ "description": "Rating of basement finished area (if multiple types)",
429
+ "values":
430
+ {
431
+ "GLQ": "Good Living Quarters",
432
+ "ALQ": "Average Living Quarters",
433
+ "BLQ": "Below Average Living Quarters",
434
+ "Rec": "Average Rec Room",
435
+ "LwQ": "Low Quality",
436
+ "Unf": "Unfinshed",
437
+ "NA": "No Basement"
438
+ }
439
+ },
440
+ { "variable": "bsmtfin_sf_2", "description": "Type 2 finished square feet" },
441
+ {
442
+ "variable": "bsmt_unf_sf",
443
+ "description": "Unfinished square feet of basement area"
444
+ },
445
+ {
446
+ "variable": "total_bsmt_sf",
447
+ "description": "Total square feet of basement area"
448
+ },
449
+ {
450
+ "variable": "heating",
451
+ "description": "Type of heating",
452
+ "values":
453
+ {
454
+ "Floor": "Floor Furnace",
455
+ "GasA": "Gas forced warm air furnace",
456
+ "GasW": "Gas hot water or steam heat",
457
+ "Grav": "Gravity furnace",
458
+ "OthW": "Hot water or steam heat other than gas",
459
+ "Wall": "Wall furnace"
460
+ }
461
+ },
462
+ {
463
+ "variable": "heating_qc",
464
+ "description": "Heating quality and condition",
465
+ "values":
466
+ {
467
+ "Ex": "Excellent",
468
+ "Gd": "Good",
469
+ "TA": "Average/Typical",
470
+ "Fa": "Fair",
471
+ "Po": "Poor"
472
+ }
473
+ },
474
+ {
475
+ "variable": "central_air",
476
+ "description": "Central air conditioning",
477
+ "values": { "N": "No", "Y": "Yes" }
478
+ },
479
+ {
480
+ "variable": "electrical",
481
+ "description": "Electrical system",
482
+ "values":
483
+ {
484
+ "SBrkr": "Standard Circuit Breakers & Romex",
485
+ "FuseA": "Fuse Box over 60 AMP and all Romex wiring (Average)",
486
+ "FuseF": "60 AMP Fuse Box and mostly Romex wiring (Fair)",
487
+ "FuseP": "60 AMP Fuse Box and mostly knob & tube wiring (poor)",
488
+ "Mix": "Mixed"
489
+ }
490
+ },
491
+ { "variable": "1st_flr_sf", "description": "First Floor square feet" },
492
+ { "variable": "2nd_flr_sf", "description": "Second floor square feet" },
493
+ {
494
+ "variable": "low_qual_fin_sf",
495
+ "description": "Low quality finished square feet (all floors)"
496
+ },
497
+ {
498
+ "variable": "gr_liv_area",
499
+ "description": "Above grade (ground) living area square feet"
500
+ },
501
+ { "variable": "bsmt_full_bath", "description": "Basement full bathrooms" },
502
+ { "variable": "bsmt_half_bath", "description": "Basement half bathrooms" },
503
+ { "variable": "full_bath", "description": "Full bathrooms above grade" },
504
+ { "variable": "half_bath", "description": "Half baths above grade" },
505
+ {
506
+ "variable": "bedroom_abvgr",
507
+ "description": "Bedrooms above grade (does NOT include basement bedrooms)"
508
+ },
509
+ { "variable": "kitchen_abvgr", "description": "Kitchens above grade" },
510
+ {
511
+ "variable": "kitchen_qual",
512
+ "description": "Kitchen quality",
513
+ "values":
514
+ {
515
+ "Ex": "Excellent",
516
+ "Gd": "Good",
517
+ "TA": "Typical/Average",
518
+ "Fa": "Fair",
519
+ "Po": "Poor"
520
+ }
521
+ },
522
+ {
523
+ "variable": "totrms_abvgrd",
524
+ "description": "Total rooms above grade (does not include bathrooms)"
525
+ },
526
+ {
527
+ "variable": "functional",
528
+ "description": "Home functionality (Assume typical unless deductions are warranted)",
529
+ "values":
530
+ {
531
+ "Typ": "Typical Functionality",
532
+ "Min1": "Minor Deductions 1",
533
+ "Min2": "Minor Deductions 2",
534
+ "Mod": "Moderate Deductions",
535
+ "Maj1": "Major Deductions 1",
536
+ "Maj2": "Major Deductions 2",
537
+ "Sev": "Severely Damaged",
538
+ "Sal": "Salvage only"
539
+ }
540
+ },
541
+ { "variable": "fireplaces", "description": "Number of fireplaces" },
542
+ {
543
+ "variable": "fireplace_qu",
544
+ "description": "Fireplace quality",
545
+ "values":
546
+ {
547
+ "Ex": "Excellent - Exceptional Masonry Fireplace",
548
+ "Gd": "Good - Masonry Fireplace in main level",
549
+ "TA": "Average - Prefabricated Fireplace in main living area or Masonry Fireplace in basement",
550
+ "Fa": "Fair - Prefabricated Fireplace in basement",
551
+ "Po": "Poor - Ben Franklin Stove",
552
+ "NA": "No Fireplace"
553
+ }
554
+ },
555
+ {
556
+ "variable": "garage_type",
557
+ "description": "Garage location",
558
+ "values":
559
+ {
560
+ "2Types": "More than one type of garage",
561
+ "Attchd": "Attached to home",
562
+ "Basment": "Basement Garage",
563
+ "BuiltIn": "Built-In (Garage part of house - typically has room above garage)",
564
+ "CarPort": "Car Port",
565
+ "Detchd": "Detached from home",
566
+ "NA": "No Garage"
567
+ }
568
+ },
569
+ { "variable": "garage_yr_blt", "description": "Year garage was built" },
570
+ {
571
+ "variable": "garage_finish",
572
+ "description": "Interior finish of the garage",
573
+ "values":
574
+ {
575
+ "Fin": "Finished",
576
+ "RFn": "Rough Finished",
577
+ "Unf": "Unfinished",
578
+ "NA": "No Garage"
579
+ }
580
+ },
581
+ { "variable": "garage_cars", "description": "Size of garage in car capacity" },
582
+ { "variable": "garage_area", "description": "Size of garage in square feet" },
583
+ {
584
+ "variable": "garage_qual",
585
+ "description": "Garage quality",
586
+ "values":
587
+ {
588
+ "Ex": "Excellent",
589
+ "Gd": "Good",
590
+ "TA": "Typical/Average",
591
+ "Fa": "Fair",
592
+ "Po": "Poor",
593
+ "NA": "No Garage"
594
+ }
595
+ },
596
+ {
597
+ "variable": "garage_cond",
598
+ "description": "Garage condition",
599
+ "values":
600
+ {
601
+ "Ex": "Excellent",
602
+ "Gd": "Good",
603
+ "TA": "Typical/Average",
604
+ "Fa": "Fair",
605
+ "Po": "Poor",
606
+ "NA": "No Garage"
607
+ }
608
+ },
609
+ {
610
+ "variable": "paved_drive",
611
+ "description": "Paved driveway",
612
+ "values": { "Y": "Paved", "P": "Partial Pavement", "N": "Dirt/Gravel" }
613
+ },
614
+ { "variable": "wood_deck_sf", "description": "Wood deck area in square feet" },
615
+ { "variable": "open_porch_sf", "description": "Open porch area in square feet" },
616
+ {
617
+ "variable": "enclosed_porch",
618
+ "description": "Enclosed porch area in square feet"
619
+ },
620
+ {
621
+ "variable": "3ssn_porch",
622
+ "description": "Three season porch area in square feet"
623
+ },
624
+ {
625
+ "variable": "screen_porch",
626
+ "description": "Screen porch area in square feet"
627
+ },
628
+ { "variable": "pool_area", "description": "Pool area in square feet" },
629
+ {
630
+ "variable": "pool_qc",
631
+ "description": "Pool quality",
632
+ "values":
633
+ {
634
+ "Ex": "Excellent",
635
+ "Gd": "Good",
636
+ "TA": "Average/Typical",
637
+ "Fa": "Fair",
638
+ "NA": "No Pool"
639
+ }
640
+ },
641
+ {
642
+ "variable": "fence",
643
+ "description": "Fence quality",
644
+ "values":
645
+ {
646
+ "GdPrv": "Good Privacy",
647
+ "MnPrv": "Minimum Privacy",
648
+ "GdWo": "Good Wood",
649
+ "MnWw": "Minimum Wood/Wire",
650
+ "NA": "No Fence"
651
+ }
652
+ },
653
+ {
654
+ "variable": "misc_feature",
655
+ "description": "Miscellaneous feature not covered in other categories",
656
+ "values":
657
+ {
658
+ "Elev": "Elevator",
659
+ "Gar2": "2nd Garage (if not described in garage section)",
660
+ "Othr": "Other",
661
+ "Shed": "Shed (over 100 SF)",
662
+ "TenC": "Tennis Court",
663
+ "NA": "None"
664
+ }
665
+ },
666
+ { "variable": "misc_val", "description": "$Value of miscellaneous feature" },
667
+ { "variable": "mo_sold", "description": "Month Sold (MM)" },
668
+ { "variable": "yr_sold", "description": "Year Sold (YYYY)" },
669
+ {
670
+ "variable": "sale_type",
671
+ "description": "Type of sale",
672
+ "values":
673
+ {
674
+ "WD": "Warranty Deed - Conventional",
675
+ "CWD": "Warranty Deed - Cash",
676
+ "VWD": "Warranty Deed - VA Loan",
677
+ "New": "Home just constructed and sold",
678
+ "COD": "Court Officer Deed/Estate",
679
+ "Con": "Contract 15% Down payment regular terms",
680
+ "ConLw": "Contract Low Down payment and low interest",
681
+ "ConLI": "Contract Low Interest",
682
+ "ConLD": "Contract Low Down",
683
+ "Oth": "Other"
684
+ }
685
+ },
686
+ {
687
+ "variable": "sale_condition",
688
+ "description": "Condition of sale",
689
+ "values":
690
+ {
691
+ "Normal": "Normal Sale",
692
+ "Abnorml": "Abnormal Sale - trade, foreclosure, short sale",
693
+ "AdjLand": "Adjoining Land Purchase",
694
+ "Alloca": "Allocation - two linked properties with separate deeds, typically condo with a garage unit",
695
+ "Family": "Sale between family members",
696
+ "Partial": "Home was not completed when last assessed (associated with New Homes)"
697
+ }
698
+ },
699
+ {
700
+ "variable": "saleprice",
701
+ "description": "Sale price $$"
702
+ }
703
+ ]
DataDocumentation.txt → originals/DataDocumentation.txt RENAMED
File without changes
preprocessing/preprocess.py CHANGED
@@ -13,7 +13,7 @@ def main():
13
  print(f"[{df.shape[0]}] rows loaded over [{df.shape[1]}] columns")
14
 
15
  # Sanitizing the column names
16
- df.columns = df.columns.str.lower().str.replace(" ", "_").str.replace(".", "")
17
 
18
  # Set the index
19
  df = df.set_index("order")
 
13
  print(f"[{df.shape[0]}] rows loaded over [{df.shape[1]}] columns")
14
 
15
  # Sanitizing the column names
16
+ df.columns = df.columns.str.lower().str.replace(" ", "_").str.replace("/", "_").str.replace(".", "")
17
 
18
  # Set the index
19
  df = df.set_index("order")