SPB Git

spb/wp2_uqo Public

UQO Working Paper No. 2 — Decoding Real Estate Descriptions: text-based hedonic analysis of housing listings.

TeX 73.8% Python 26%
1.4 KB

# data/ — not tracked by git

This directory is excluded from version control because:

  1. raw/louka.db (268 MB) exceeds GitHub's 100 MB per-file limit;
  2. the database contains a leftover application users table (credentials) that must not be published;
  3. the listing texts are proprietary platform content (Realtor.ca / Centris).

# Restoring the data locally

Place the SQLite database at:

text
data/raw/louka.db        # table `properties`: 46,479 listings, 5 categories

(or set the environment variable WP2_DB_PATH to its location), then run the pipeline from the repository root:

bash
python3 scripts/01_prepare_data.py
python3 scripts/02_similarities.py
python3 scripts/03_models.py
python3 scripts/04_robustness.py
python3 scripts/05_figures.py
python3 scripts/06_tables.py

The pipeline recreates everything under data/processed/:

File Content
houses.parquet analysis sample (17,087 × 14, incl. remarks text)
embeddings_maisons.npy 17,087 × 384 sentence embeddings (cache)
sim_matrix_maisons.npy 17,087 × 20 cosine-similarity matrix
hedonic_maison_results.csv analysis dataset used by all models/figures
legacy/ pre-refactor artifacts kept for byte-level comparison

Embeddings are deterministic for a given all-MiniLM-L6-v2 model version, so a fresh run reproduces the committed results exactly (see CHANGES.md §3).