misikoff commited on
Commit
83142d3
1 Parent(s): 27a0327

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -244
README.md CHANGED
@@ -50,249 +50,13 @@ This dataset contains several configs produced based on files available at https
50
 
51
  # Processing Notes
52
 
53
- This dataset contains only parquet files created from the raw Zillow data. For code related to processing that data and creating the parquet files see https://huggingface.co/datasets/misikoff/zillow.
54
 
55
  Supported configs:
56
- - [`days_on_market`](#days-on-market): Days to pending, days to close, share of listings with a price cut, and price cuts.
57
- - [`for_sale_listings`](#for-sale-listings): Median listing price, new listings, and new pending listings.
58
- - [`home_values`](#home-values): Zillow Home Value Index (ZHVI) for all homes, mid-tier, bottom-tier, and top-tier homes.
59
- - [`home_values_forecasts`](#home-values-forecasts): Zillow Home Value Forecast (ZHVF) for all homes, mid-tier, bottom-tier, and top-tier homes.
60
- - [`new_construction`](#new-construction): Median sale price, median sale price per square foot, and sales count.
61
- - [`rentals`](#rentals): Zillow Observed Rent Index (ZORI) for all homes, mid-tier, bottom-tier, and top-tier homes.
62
- - [`sales`](#sales): Median sale price, median sale price per square foot, and sales count.
63
-
64
- ## DAYS ON MARKET AND PRICE CUTS (TODO investigate columns more)
65
-
66
- Days to Pending: How long it takes homes in a region to change to pending status on Zillow.com after first being shown as for sale. The reported figure indicates the number of days (mean or median) that it took for homes that went pending during the week being reported, to go pending. This differs from the old “Days on Zillow” metric in that it excludes the in-contract period before a home sells.
67
- Days to Close (mean/median): Number of days between the listing going pending and the sale date.
68
- Share of Listings With a Price Cut: The number of unique properties with a list price at the end of the month that’s less than the list price at the beginning of the month, divided by the number of unique properties with an active listing at some point during the month.
69
- Price Cuts: The mean and median price cut for listings in a given region during a given time period, expressed as both dollars ($) and as a percentage (%) of list price.
70
-
71
- Base Columns
72
- - `Region ID`: dtype="string", a unique identifier for the region
73
- - `Size Rank`: dtype="int32", a rank of the region's size
74
- - `Region`: dtype="string", the name of the region
75
- - `Region Type`: dtype="class_label", the type of region
76
- - '0': zip
77
- - '1': city
78
- - '2': county
79
- - '3': msa
80
- - '4': state
81
- - '5': country
82
- - `State`: dtype="string", the US state abbreviation for the state containing the region
83
- - `Home Type`: dtype="string", the type of home
84
- - '0': multifamily
85
- - '1': condo/co-op
86
- - '2': SFR
87
- - '3': all homes
88
- - '4': all homes plus multifamily
89
- - `Date`: dtype="timestamp[ms]", the date of the last day of the week for this data
90
-
91
- Value Columns
92
- - `Mean Listings Price Cut Amount (Smoothed)`: dtype="float32"
93
- - `Percent Listings Price Cut`: dtype="float32", The number of unique properties with a list price at the end of the month that’s less than the list price at the beginning of the month, divided by the number of unique properties with an active listing at some point during the month.
94
- - `Mean Listings Price Cut Amount`: dtype="float32"
95
- - `Percent Listings Price Cut (Smoothed)`: dtype="float32"
96
- - `Median Days on Pending (Smoothed)`: dtype="float32", median number of days it takes for homes in a region to change to pending status on Zillow.com after first being shown as for sale. (smoothed)
97
- - `Median Days on Pending`: dtype="float32", median number of days it takes for homes in a region to change to pending status on Zillow.com after first being shown as for sale.
98
-
99
- ## FOR-SALE LISTINGS
100
-
101
- Base Columns
102
- - `Region ID`: dtype="string", a unique identifier for the region
103
- - `Size Rank`: dtype="int32", a rank of the region's size
104
- - `Region`: dtype="string", the name of the region
105
- - `Region Type`: dtype="class_label", the type of region
106
- - '0': zip
107
- - '1': city
108
- - '2': county
109
- - '3': msa
110
- - '4': state
111
- - `State`: dtype="string", the US state abbreviation for the state containing the region
112
- - `Home Type`: dtype="string", the type of home
113
- - '0': all homes
114
- - '1': all homes plus multifamily
115
- - '2': SFR
116
- - '3': condo/co-op
117
- - '4': multifamily
118
- - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
119
-
120
- Value Columns
121
- - `Median Listing Price`: dtype="float32", The median price at which homes across various geographies were listed.
122
- - `Median Listing Price (Smoothed)`: dtype="float32", The median price at which homes across various geographies were listed. (smoothed)
123
- - `New Listings`: dtype="int32", how many new listings have come on the market in a given month
124
- - `New Listings (Smoothed)`: dtype="int32", how many new listings have come on the market in a given month. (smoothed)
125
- - `New Pending (Smoothed)`: dtype="int32", The count of listings that changed from for-sale to pending status on Zillow.com in a given time period. (smoothed)
126
- - `New Pending`: dtype="int32", The count of listings that changed from for-sale to pending status on Zillow.com in a given time period.
127
-
128
-
129
- ## HOME VALUES
130
-
131
- <!-- Zillow Home Value Index (ZHVI): A measure of the typical home value and market changes across a given region and housing type. It reflects the typical value for homes in the 35th to 65th percentile range. Available as a smoothed, seasonally adjusted measure and as a raw measure. -->
132
-
133
- <!-- Zillow publishes top-tier ZHVI (\$, typical value for homes within the 65th to 95th percentile range for a given region) and bottom-tier ZHVI (\$, typical value for homes within the 5th to 35th percentile range for a given region). -->
134
-
135
- <!-- Zillow also publishes ZHVI for all single-family residences (\$, typical value for all single-family homes in a given region), for condo/coops (\$), for all homes with 1, 2, 3, 4 and 5+ bedrooms (\$), and the ZHVI per square foot (\$, typical value of all homes per square foot calculated by taking the estimated home value for each home in a given region and dividing it by the home’s square footage). -->
136
-
137
- <!-- Note: Starting with the January 2023 data release, and for all subsequent releases, the full ZHVI time series has been upgraded to harness the power of the neural Zestimate. -->
138
-
139
- <!-- More information about what ZHVI is and how it’s calculated is available on this overview page. Here’s a handy ZHVI User Guide for information about properly citing and making calculations with this metric. -->
140
-
141
- Base Columns
142
- - `Region ID`: dtype="string", a unique identifier for the region
143
- - `Size Rank`: dtype="int32", a rank of the region's size
144
- - `Region`: dtype="string", the name of the region
145
- - `Region Type`: dtype="class_label", the type of region
146
- - '0': zip
147
- - '1': city
148
- - '2': county
149
- - '3': msa
150
- - '4': state
151
- - '5': country"
152
- - `State`: dtype="string", the US state abbreviation for the state containing the region
153
- - `Home Type`: dtype="class_label", the type of home
154
- - '0': multifamily
155
- - '1': condo/co-op
156
- - '2': SFR
157
- - '3': all homes
158
- - '4': all homes plus multifamily
159
- - `Bedroom Count`: dtype="class_label", the number of bedrooms
160
- - '0': 1-Bedroom
161
- - '1': 2-Bedrooms
162
- - '2': 3-Bedrooms
163
- - '3': 4-Bedrooms
164
- - '4': 5+-Bedrooms
165
- - '5': All Bedrooms
166
- - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
167
-
168
- Value Columns
169
- - `Mid Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
170
- - `Bottom Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
171
- - `Top Tier ZHVI (Smoothed) (Seasonally Adjusted)`: dtype="float32",
172
- - `ZHVI`: dtype="float32",
173
- - `Mid Tier ZHVI`: dtype="float32"
174
-
175
-
176
- ## HOME VALUES FORECASTS
177
-
178
- <!-- Zillow Home Value Forecast (ZHVF): A month-ahead, quarter-ahead and year-ahead forecast of the Zillow Home Value Index (ZHVI). ZHVF is created using the all homes, mid-tier cut of ZHVI and is available both raw and smoothed, seasonally adjusted. -->
179
-
180
- <!-- Note: Starting with the January 2023 forecast (made available in February 2023), Zillow’s Home Value Forecast is based on the upgraded ZHVI that harnesses the power of the neural Zestimate. More information about what ZHVI is and how it’s calculated is available on this overview page. -->
181
-
182
- Base Columns
183
- - `Region ID`: dtype="string", a unique identifier for the region
184
- - `Size Rank`: dtype="int32", a rank of the region's size
185
- - `Region`: dtype="string", the name of the region
186
- - `Region Type`: dtype="class_label", the type of region
187
- - '0': county
188
- - '1': city
189
- - '2': zip
190
- - '3': country
191
- - '4': msa
192
- - `State`: dtype="string", the US state abbreviation for the state containing the region
193
- - `City`: dtype="string",
194
- - `Metro`: dtype="string",
195
- - `County`: dtype="string",
196
- - `Home Type`: dtype="string", the type of home
197
- - `Date`: dtype="timestamp[ms]", the date of these forecasts
198
-
199
- Value Columns
200
- - `Month Over Month % (Smoothed)`: dtype="float32",
201
- - `Quarter Over Quarter % (Smoothed)`: dtype="float32",
202
- - `Year Over Year % (Smoothed)`: dtype="float32"
203
- - `Month Over Month % (Raw)`: dtype="float32"
204
- - `Quarter Over Quarter % (Raw)`: dtype="float32"
205
- - `Year Over Year % (Raw)`: dtype="float32"
206
-
207
- ## NEW CONSTRUCTION
208
-
209
- Base Columns
210
- - `Region ID`: dtype="string", a unique identifier for the region
211
- - `Size Rank`: dtype="int32", a rank of the region's size
212
- - `Region`: dtype="string", the name of the region
213
- - `Region Type`: dtype="class_label", the type of region
214
- - '0': county
215
- - '1': city
216
- - '2': zip
217
- - '3': country
218
- - '4': msa
219
- - `State`: dtype="string", the US state abbreviation for the state containing the region
220
- - `Home Type`: dtype="class_label", the type of home
221
- - '0': all homes
222
- - '1': all homes plus multifamily
223
- - '2': SFR
224
- - '3': condo/co-op
225
- - '4': multifamily
226
- - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
227
-
228
- Value Columns
229
- - `Median Sale Price`: dtype="float32", the median sale price of new construction homes that sold during the month in the specified region
230
- - `Median Sale Price per Sqft`: dtype="float32", the median sale price per square foot of new construction homes that sold during the month in the specified region
231
- - `Sales Count`: dtype="int32", the number of new construction homes that sold during the month in the specified region
232
-
233
- ## RENTALS
234
-
235
- Base Columns
236
- - `Region ID`: dtype="string", a unique identifier for the region
237
- - `Size Rank`: dtype="int32", a rank of the region's size
238
- - `Region`: dtype="string", the name of the region
239
- - `Region Type`: dtype="class_label", the type of region
240
- - '0': county
241
- - '1': city
242
- - '2': zip
243
- - '3': country
244
- - '4': msa
245
- - `State`: dtype="string", the US state abbreviation for the state containing the region
246
- - `Home Type`: dtype="string", the type of home
247
- - '0': all homes
248
- - '1': all homes plus multifamily
249
- - '2': SFR
250
- - '3': condo/co-op
251
- - '4': multifamily
252
- - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
253
-
254
- Value Columns
255
- - `Rent (Smoothed)`: dtype="float32", Zillow Observed Rent Index (ZORI): A smoothed measure of the typical observed market rate rent across a given region. ZORI is a repeat-rent index that is weighted to the rental housing stock to ensure representativeness across the entire market, not just those homes currently listed for-rent. The index is dollar-denominated by computing the mean of listed rents that fall into the 40th to 60th percentile range for all homes and apartments in a given region, which is weighted to reflect the rental housing stock.
256
- - `Rent (Smoothed) (Seasonally Adjusted)`: dtype="float32", Zillow Observed Rent Index (ZORI) :A smoothed measure of the typical observed market rate rent across a given region. ZORI is a repeat-rent index that is weighted to the rental housing stock to ensure representativeness across the entire market, not just those homes currently listed for-rent. The index is dollar-denominated by computing the mean of listed rents that fall into the 40th to 60th percentile range for all homes and apartments in a given region, which is weighted to reflect the rental housing stock.
257
-
258
- ## SALES (TODO investigate columns)
259
- <!-- Sale-to-List Ratio (mean/median): Ratio of sale vs. final list price. -->
260
- <!-- Percent of Sales Below/Above List: Share of sales where sale price below/above the final list price; excludes homes sold for exactly the list price. -->
261
-
262
- Base Columns
263
- - `Region ID`: dtype="string", a unique identifier for the region
264
- - `Size Rank`: dtype="int32", a rank of the region's size
265
- - `Region`: dtype="string", the name of the region
266
- - `Region Type`: dtype="class_label", the type of region
267
- - '0': county
268
- - '1': city
269
- - '2': zip
270
- - '3': country
271
- - '4': msa
272
- - `State`: dtype="string", the US state abbreviation for the state containing the region
273
- - `Home Type`: dtype="class_label", the type of home
274
- - '0': all homes
275
- - '1': all homes plus multifamily
276
- - '2': SFR
277
- - '3': condo/co-op
278
- - '4': multifamily
279
- - `Date`: dtype="timestamp[ms]", the date of the last day of the month for this data
280
-
281
- Value Columns
282
- - `Median Sale Price`: dtype="float32", The median price at which homes across various geographies were sold.
283
- - `Median Sale Price per Sqft`: dtype="float32" The median price per square foot at which homes across various geographies were sold.
284
- - `Sales Count`: dtype="int32", The "Sales Count Nowcast" is the estimated number of unique properties that sold during the month after accounting for the latency between when sales occur and when they are reported.
285
-
286
- ## DEFINITIONS OF HOME TYPES
287
- - all Homes: Zillow defines all homes as single-family, condominium and co-operative homes with a county record. Unless specified, all series cover this segment of the housing stock.
288
- - SFR: single family residence
289
- - condo/co-op: Condominium and co-operative homes.
290
- - Multifamily 5+ units: Units in buildings with 5 or more housing units, that are not condominiums or co-ops.
291
- <!-- - Duplex/Triplex/Quadplex: Housing units in buildings with 2, 3, or 4 housing units. -->
292
-
293
- # Example Usage
294
- ```python
295
- from datasets import load_dataset
296
-
297
- dataset = load_dataset("misikoff/zillow-viewer", 'home_values', trust_remote_code=True)
298
- ```
 
50
 
51
  # Processing Notes
52
 
53
+ This dataset contains only parquet files created from the raw Zillow data. For more information, as well as code related to processing that data and creating the parquet files see https://huggingface.co/datasets/misikoff/zillow.
54
 
55
  Supported configs:
56
+ - `days_on_market`: Days to pending, days to close, share of listings with a price cut, and price cuts.
57
+ - `for_sale_listings`: Median listing price, new listings, and new pending listings.
58
+ - `home_values`: Zillow Home Value Index (ZHVI) for all homes, mid-tier, bottom-tier, and top-tier homes.
59
+ - `home_values_forecasts`: Zillow Home Value Forecast (ZHVF) for all homes, mid-tier, bottom-tier, and top-tier homes.
60
+ - `new_construction`: Median sale price, median sale price per square foot, and sales count.
61
+ - `rentals`: Zillow Observed Rent Index (ZORI) for all homes, mid-tier, bottom-tier, and top-tier homes.
62
+ - `sales`: Median sale price, median sale price per square foot, and sales count.