SpringWang08 commited on
Commit
e1b63d9
·
verified ·
1 Parent(s): e6c425b

add datasets for space

Browse files
Files changed (5) hide show
  1. .gitattributes +1 -0
  2. README.md +133 -270
  3. clean_dataset.csv +3 -0
  4. raw/clean_data.csv +0 -0
  5. raw/clean_hanoi.csv +0 -0
.gitattributes CHANGED
@@ -41,3 +41,4 @@ Web/ph_n_t_ch_th_tr_ng/screen.png filter=lfs diff=lfs merge=lfs -text
41
  Web/ph_ng_th_nghi_m_quy_t_nh/screen.png filter=lfs diff=lfs merge=lfs -text
42
  Web/t_ng_quan_quy_t_nh_chi_n_l_c/screen.png filter=lfs diff=lfs merge=lfs -text
43
  Web/tr_l_ai/screen.png filter=lfs diff=lfs merge=lfs -text
 
 
41
  Web/ph_ng_th_nghi_m_quy_t_nh/screen.png filter=lfs diff=lfs merge=lfs -text
42
  Web/t_ng_quan_quy_t_nh_chi_n_l_c/screen.png filter=lfs diff=lfs merge=lfs -text
43
  Web/tr_l_ai/screen.png filter=lfs diff=lfs merge=lfs -text
44
+ clean_dataset.csv filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -1,321 +1,184 @@
1
  ---
2
- title: PropertyVision BI x RAG
3
- emoji: 🏢
4
- colorFrom: blue
5
- colorTo: indigo
6
- sdk: docker
7
- app_port: 7860
 
 
 
 
 
 
 
 
 
 
 
 
8
  ---
9
 
10
- # PropertyVision BI x RAG
11
-
12
- <p align="center">
13
- <img src="docs/assets/readme-banner.svg" alt="PropertyVision BI x RAG banner" width="100%" />
14
- </p>
15
-
16
- > Executive-grade real-estate decision intelligence for **Ho Chi Minh City** and **Hanoi**.
17
- > BI dashboards, price prediction, what-if simulation, GIS/planning views, and a retrieval-first AI assistant for leadership reporting.
18
-
19
- <p align="center">
20
- <a href="https://github.com/QuangVoAI/PropertyVision/releases/tag/v1.0.0"><img src="https://img.shields.io/badge/release-v1.0.0-0f766e?style=for-the-badge" alt="release v1.0.0" /></a>
21
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/stack-FastAPI_%7C_React_%7C_RAG-1d4ed8?style=for-the-badge" alt="FastAPI React RAG" /></a>
22
- <a href="https://huggingface.co/datasets/SpringWang08/hanoi-hcmc-real-estate"><img src="https://img.shields.io/badge/dataset-Hugging%20Face-f59e0b?style=for-the-badge" alt="Hugging Face dataset" /></a>
23
- <a href="https://huggingface.co"><img src="https://img.shields.io/badge/AI-Hosted%20Qwen%20%2B%20RAG-7c3aed?style=for-the-badge" alt="Hosted Qwen plus RAG" /></a>
24
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/NLP-Retrieval--First%20Assistant-0891b2?style=for-the-badge" alt="NLP assistant" /></a>
25
- </p>
26
-
27
- <p align="center">
28
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/FastAPI-0ea5e9?style=flat-square&logo=fastapi&logoColor=white" alt="FastAPI" /></a>
29
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/React-0f172a?style=flat-square&logo=react&logoColor=61dafb" alt="React" /></a>
30
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/RAG-0f766e?style=flat-square" alt="RAG" /></a>
31
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/NLP-7c3aed?style=flat-square" alt="NLP" /></a>
32
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/Metro-2563eb?style=flat-square" alt="Metro impact" /></a>
33
- <a href="https://github.com/QuangVoAI/PropertyVision"><img src="https://img.shields.io/badge/v1.0.0-111827?style=flat-square" alt="Version 1.0.0" /></a>
34
- </p>
35
-
36
- ## Quick Links
37
-
38
- - [What You Get](#what-you-get)
39
- - [Quick Start](#quick-start)
40
- - [Environment Variables](#environment-variables)
41
- - [Hugging Face Space](#hugging-face-space)
42
- - [Metro Impact Data](#metro-impact-data)
43
- - [Useful Backend Endpoints](#useful-backend-endpoints)
44
- - [Documentation](#documentation)
45
-
46
- ## What You Get
47
-
48
- - 📊 Executive dashboard with market KPIs and trend views
49
- - 🧩 Multi-dimensional slice-dice analysis
50
- - 📈 Price prediction and ROI simulation
51
- - 🗺️ Planning/GIS map with opportunity and risk views
52
- - 🤖 RAG-based assistant grounded in market, planning, legal, and metro context
53
- - 📝 Export-friendly periodic report view for leadership updates
54
-
55
- ## At a Glance
56
-
57
- | Item | Value |
58
- |---|---|
59
- | Release | `v1.0.0` |
60
- | Main stack | `FastAPI + React + Vite` |
61
- | AI layer | `Hosted Qwen + retrieval-first RAG` |
62
- | Markets covered | `Ho Chi Minh City`, `Hanoi` |
63
- | Metro scope | `Bến Thành`, `Tham Lương`, `HCMC TOD`, `Hanoi TOD` |
64
- | Primary dataset | `datasets/clean_dataset.csv` |
65
-
66
- ## Architecture
67
-
68
- ```mermaid
69
- flowchart LR
70
- U[User] --> F[React + Vite Frontend]
71
- F --> B[FastAPI Backend]
72
-
73
- HF[Hugging Face Dataset<br/>SpringWang08/hanoi-hcmc-real-estate] --> D[datasets/clean_dataset.csv]
74
- D --> M[Runtime Data Mart<br/>SQLite + Pandas]
75
- M --> B
76
-
77
- B --> A[Analytics / Prediction / Simulation]
78
- B --> G[GIS / Planning / Metro impact]
79
- B --> R[RAG Retriever]
80
- R --> Q[Hosted Qwen]
81
- Q --> O[Executive response]
82
-
83
- A --> F
84
- G --> F
85
- O --> F
86
- ```
87
-
88
- ## Repository Layout
89
-
90
- ```text
91
- PropertyVision/
92
- ├── backend/ FastAPI app, analytics, RAG, metro/planning data
93
- ├── frontend/ React + Vite UI
94
- ├── datasets/ Processed dataset, dataset notes, cached reference data
95
- ├── docs/ Diagrams, baseline notes, demo scripts, UI spec
96
- ├── data/ SQLite runtime artifacts
97
- ├── README.md Project overview and setup
98
- └── requirements.txt Python dependencies
99
- ```
100
-
101
- ## Data Model
102
-
103
- The application works with a processed dataset and runtime-generated analytical layers:
104
-
105
- - `datasets/clean_dataset.csv` is the main processed dataset
106
- - `data/*.db` is created at runtime for facts, planning zones, legal notes, and metro impact profiles
107
- - the backend also builds a cached street-level reference for richer RAG answers
108
-
109
- ### Automatic dataset behavior
110
-
111
- On first backend start, the app will try to:
112
-
113
- 1. download the processed dataset from Hugging Face
114
- 2. store it locally as `datasets/clean_dataset.csv`
115
- 3. fall back to the local file if it already exists
116
- 4. fall back to raw reference data in `datasets/raw/` if needed
117
-
118
- This means a fresh clone can usually start without manual data copying.
119
-
120
- Dataset links:
121
-
122
- - https://huggingface.co/datasets/SpringWang08/hanoi-hcmc-real-estate
123
- - https://huggingface.co/datasets/tinixai/vietnam-real-estates
124
-
125
- ## Quick Start
126
-
127
- ### 1. Clone
128
-
129
- ```bash
130
- git clone https://github.com/QuangVoAI/PropertyVision.git
131
- cd PropertyVision
132
- ```
133
-
134
- ### 2. Set up the backend
135
 
136
- macOS / Linux:
137
 
138
- ```bash
139
- python -m venv .venv
140
- source .venv/bin/activate
141
- pip install -r requirements.txt
142
- uvicorn backend.main:app --reload
143
- ```
144
 
145
- Windows PowerShell:
 
146
 
147
- ```powershell
148
- python -m venv .venv
149
- .venv\Scripts\Activate.ps1
150
- pip install -r requirements.txt
151
- uvicorn backend.main:app --reload
152
- ```
153
 
154
- Backend URL:
155
 
156
- ```text
157
- http://localhost:8000
158
- ```
 
 
159
 
160
- ### 3. Set up the frontend
161
 
162
- ```bash
163
- cd frontend
164
- npm install
165
- npm run dev
166
- ```
167
 
168
- Frontend URL:
 
 
 
 
169
 
170
- ```text
171
- http://localhost:5173
172
- ```
173
 
174
- ## Hugging Face Space
175
 
176
- This repository already includes a `Dockerfile`, so you can upload it to **Hugging Face Spaces** as a Docker Space with minimal extra work.
 
 
 
 
 
 
 
 
177
 
178
- - The backend serves the built frontend from `frontend/dist`
179
- - The app runs on port `7860` in Spaces
180
- - Use the root `README.md` as the Space landing page
181
 
182
- If you want a shorter Vietnamese guide for the same project, see [README.vi.md](README.vi.md).
183
 
184
- ## Environment Variables
185
 
186
- The app works in retrieval-only mode without a hosted LLM token, but you can enable hosted generation for richer analysis.
187
 
188
- Recommended variables:
189
 
190
- ```bash
191
- HF_TOKEN=your_hugging_face_token
192
- PROPERTYVISION_HF_QWEN_MODEL=Qwen/Qwen2.5-1.5B-Instruct
193
- PROPERTYVISION_HF_INFERENCE_PROVIDER=auto
194
- PROPERTYVISION_USE_HOSTED_QWEN=true
195
- ```
196
-
197
- Optional `.env` file at the project root is supported.
 
 
 
 
 
 
 
 
 
 
 
 
198
 
199
- ### Notes
200
 
201
- - If no hosted model is available, the app still runs with retrieval-backed analysis.
202
- - If you want faster local debugging with less AI overhead, keep the hosted model disabled.
203
 
204
- ## Core Features
205
 
206
- ### 1. 📌 Tổng quan điều hành
207
 
208
- - KPI trọng yếu
209
- - xu hướng điều hành dài hạn
210
- - kiểm tra giả định tăng trưởng
211
- - khuyến nghị dành cho ban điều hành
212
 
213
- ### 2. 🏙️ Thông tin thị trường
214
 
215
- - so sánh khu vực
216
- - mặt bằng giá
217
- - phân tích phân khúc
218
- - insight theo thành phố / quận / loại tài sản
219
 
220
- ### 3. 🔎 Phân tích đa chiều
 
 
 
 
221
 
222
- - slice-dice theo khu vực và phân khúc
223
- - bảng phân đoạn tiềm năng cao
224
- - xem danh sách địa chỉ theo từng record
225
 
226
- ### 4. 📊 phỏng đầu
227
 
228
- - giá trị tương lai
229
- - lợi nhuận vốn
230
- - ROI tích lũy
231
- - thời gian hoàn vốn
232
- - khuyến nghị mua thêm / giữ / bán bớt
233
 
234
- ### 5. 🗺️ Bản đồ quy hoạch
 
 
 
 
 
235
 
236
- - opportunity score
237
- - risk level
238
- - bộ lọc theo ROI, score và rủi ro
239
- - dữ liệu quy hoạch, legal, và metro impact
240
 
241
- ### 6. 🤖 Trợ phân tích
242
 
243
- - hỏi đáp theo ngữ cảnh RAG
244
- - nguồn trích dẫn rõ ràng
245
- - khuyến nghị ngắn gọn theo giọng điều hành
246
 
247
- ### 7. 📝 Báo cáo định kỳ
248
 
249
- - bản tóm tắt kiểu executive report
250
- - hỗ trợ in ra PDF từ trình duyệt
 
 
 
 
 
251
 
252
- ## Metro Impact Data
253
 
254
- The backend now includes a dedicated metro-impact layer for real estate analysis:
255
 
256
- - Ho Chi Minh City metro line 1
257
- - Ben Thanh central station
258
- - Tham Luong station / metro line 2 gateway
259
- - Hanoi TOD and urban rail corridor references
 
 
 
260
 
261
- This layer is available through the RAG pipeline and the data-ops view so the assistant can answer questions like:
262
 
263
- - “Metro ảnh hưởng giá nhà như thế nào?”
264
- - “Bến Thành và Tham Lương tác động ra sao?”
265
- - “Hà Nội và TP.HCM khác nhau thế nào quanh ga metro?”
266
 
267
- There is also an API endpoint:
268
 
269
- ```text
270
- GET /api/metro/impact
271
- ```
 
272
 
273
- ## Refreshing Data
274
 
275
- If you change planning, legal, metro, or market sources, refresh the runtime layers:
276
 
277
- ```text
278
- POST /api/etl/run
279
- POST /api/rag/reindex
 
 
 
 
 
280
  ```
281
 
282
- You can also use the **Theo dõi dữ liệu** page in the UI to do this.
283
-
284
- ## Useful Backend Endpoints
285
-
286
- - `GET /api/metadata`
287
- - `POST /api/analytics`
288
- - `POST /api/slice-dice`
289
- - `POST /api/predict`
290
- - `POST /api/what-if`
291
- - `GET /api/map/districts`
292
- - `GET /api/planning/zones`
293
- - `GET /api/metro/impact`
294
- - `POST /api/rag/reindex`
295
- - `GET /api/etl/status`
296
- - `GET /api/ai/status`
297
-
298
- ## Notes For Contributors
299
-
300
- - The repository is designed so that a new clone can run end-to-end with minimal manual setup.
301
- - Avoid committing generated runtime files from `data/` and downloaded dataset artifacts unless intentional.
302
- - If you update the dataset or knowledge base, reindex RAG so the assistant reflects the latest state.
303
-
304
- ## 📚 Documentation
305
-
306
- - [Project Diagrams](docs/PROJECT_DIAGRAMS.md)
307
- - [Technical Baseline](docs/BASELINE.md)
308
- - [Demo Script](docs/DEMO_SCRIPT.md)
309
- - [UI Design Spec](docs/UI_DESIGN_SPEC.md)
310
-
311
- ## 🎁 Release Notes
312
-
313
- - Official `v1.0.0` release for executive-grade real-estate intelligence.
314
- - Adds a cleaner onboarding README so new contributors can clone and run faster.
315
- - Includes metro-impact data and RAG coverage for Ho Chi Minh City and Hanoi.
316
- - Keeps the AI experience retrieval-first, with hosted Qwen available when configured.
317
-
318
- ## 🪪 License / Data Use
319
 
320
- This project aggregates public, processed, and derivative analytical data for BI and demonstration purposes.
321
- Please review the source terms of any upstream data before redistribution or commercial use.
 
1
  ---
2
+ language:
3
+ - vi
4
+ license: other
5
+ task_categories:
6
+ - tabular-classification
7
+ - tabular-regression
8
+ tags:
9
+ - real-estate
10
+ - vietnam
11
+ - hanoi
12
+ - ho-chi-minh-city
13
+ - business-intelligence
14
+ - property-analytics
15
+ - tabular
16
+ - pandas
17
+ pretty_name: Hanoi & Ho Chi Minh City Real Estate Dataset
18
+ size_categories:
19
+ - 100K<n<1M
20
  ---
21
 
22
+ # Hanoi & Ho Chi Minh City Real Estate Dataset
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
 
24
+ ## Dataset Summary
25
 
26
+ This dataset is a cleaned, consolidated, and analysis-ready real estate dataset covering two major Vietnamese urban markets:
 
 
 
 
 
27
 
28
+ - **Hanoi**
29
+ - **Ho Chi Minh City**
30
 
31
+ It was prepared for **PropertyVision BI**, a business intelligence and decision-support project focused on property analytics, price prediction, ROI analysis, planning-risk exploration, and dashboard-based market monitoring.
 
 
 
 
 
32
 
33
+ The dataset is designed for:
34
 
35
+ - exploratory data analysis
36
+ - dashboarding and BI use cases
37
+ - tabular machine learning
38
+ - market segmentation
39
+ - investment scenario analysis
40
 
41
+ ## Why This Dataset Matters
42
 
43
+ This dataset was built to demonstrate more than simple data collection. It reflects a practical end-to-end analytics workflow that is highly relevant for portfolio and CV use cases:
 
 
 
 
44
 
45
+ - multi-source tabular data consolidation
46
+ - schema harmonization across two major cities
47
+ - feature standardization for business intelligence and machine learning
48
+ - rule-based enrichment for incomplete records
49
+ - validation-oriented preprocessing for downstream product stability
50
 
51
+ For recruiters or reviewers, this dataset highlights work across **data cleaning, dataset design, feature engineering, data validation, and analytics product thinking** rather than only model training.
 
 
52
 
53
+ ## Quick Stats
54
 
55
+ | Metric | Value |
56
+ |---|---:|
57
+ | Total rows | 106,205 |
58
+ | Cities covered | 2 |
59
+ | Ho Chi Minh City rows | 23,722 |
60
+ | Hanoi rows | 82,483 |
61
+ | Main data file | `clean_dataset.csv` |
62
+ | Format | CSV |
63
+ | Primary use | BI, analytics, ML experimentation |
64
 
65
+ ## Dataset Structure
 
 
66
 
67
+ The main file in this repository is:
68
 
69
+ - `clean_dataset.csv`
70
 
71
+ Each row represents a processed property listing or synthesized listing record prepared for downstream analytics.
72
 
73
+ ### Core Columns
74
 
75
+ - `Location`: normalized location label
76
+ - `Price`: human-readable property price
77
+ - `Type of House`: property category
78
+ - `Land Area`: human-readable area label
79
+ - `Bedrooms`: bedroom count label
80
+ - `Toilets`: toilet count label
81
+ - `Total Floors`: number of floors
82
+ - `Main Door Direction`: main door orientation
83
+ - `Balcony Direction`: balcony orientation
84
+ - `Legal Documents`: legal status label
85
+ - `price_vnd`: numeric property price in VND
86
+ - `area`: numeric land/building area
87
+ - `price_per_m2`: numeric price per square meter
88
+ - `district`: district label
89
+ - `purchase_price`: estimated purchase price proxy
90
+ - `current_price`: current price proxy
91
+ - `ROI`: return-on-investment proxy
92
+ - `date`: normalized date field
93
+ - `city`: city label
94
+ - `source_dataset`: original source file identifier
95
 
96
+ ## Data Sources
97
 
98
+ This dataset is a curated derivative dataset built from cleaned source data used in the PropertyVision project.
 
99
 
100
+ The underlying information was assembled from public and educational data sources referenced in the project, including public planning/GIS references and real estate market proxy data.
101
 
102
+ This repository publishes the **processed analytical dataset**, not a claim of ownership over all raw source records.
103
 
104
+ Because this is a derivative analytical release, users should review upstream source terms before using the dataset for redistribution or commercial applications.
 
 
 
105
 
106
+ ## Preprocessing and Curation
107
 
108
+ The published dataset was prepared through several curation steps:
 
 
 
109
 
110
+ 1. schema standardization across city-level datasets
111
+ 2. column normalization for price, area, ROI, district, and date fields
112
+ 3. consolidation of Hanoi and Ho Chi Minh City records into one tabular dataset
113
+ 4. generation of business-ready derived fields such as `purchase_price`, `current_price`, and `price_per_m2`
114
+ 5. consistency validation for property-type-specific rules
115
 
116
+ ## Important Note on Synthetic Enrichment
 
 
117
 
118
+ Some Hanoi records originally had fewer attributes than the Ho Chi Minh City dataset.
119
 
120
+ To create a unified schema for analytics and demo applications, selected fields for Hanoi were enriched using **deterministic rule-based preprocessing**, including:
 
 
 
 
121
 
122
+ - property type inference
123
+ - bedroom and toilet count estimation
124
+ - floor count estimation
125
+ - legal document label approximation
126
+ - directional field completion
127
+ - normalized location labeling
128
 
129
+ These enriched values were created to support **schema consistency, dashboard stability, and machine learning experimentation**.
 
 
 
130
 
131
+ They should be treated as **synthetic analytical enrichments**, not guaranteed ground-truth metadata.
132
 
133
+ ## Intended Use
 
 
134
 
135
+ Recommended use cases:
136
 
137
+ - BI dashboards
138
+ - market comparison between Hanoi and Ho Chi Minh City
139
+ - regression experiments for property price estimation
140
+ - ROI analysis
141
+ - feature engineering practice
142
+ - educational data projects
143
+ - portfolio projects in analytics, data science, and data engineering
144
 
145
+ ## Skills Demonstrated
146
 
147
+ This dataset release demonstrates the following practical skills:
148
 
149
+ - data cleaning and tabular preprocessing
150
+ - schema design and dataset consolidation
151
+ - feature engineering for property analytics
152
+ - rule-based synthetic enrichment for incomplete records
153
+ - validation rule design for data consistency
154
+ - business intelligence thinking for dashboard-ready data products
155
+ - preparation of shareable ML and analytics assets for public repositories
156
 
157
+ ## Author
158
 
159
+ Curated and released by **Xuan Quang Vo** as part of the **PropertyVision BI** project.
 
 
160
 
161
+ ## Limitations
162
 
163
+ - This dataset is intended primarily for **analytics and educational use**.
164
+ - Some fields are cleaned proxies rather than directly verified transaction records.
165
+ - Some Hanoi attributes are **synthetically enriched** for consistency.
166
+ - The dataset should not be used as the sole basis for legal, financial, or investment decisions.
167
 
168
+ ## Citation
169
 
170
+ If you use this dataset, please cite it as:
171
 
172
+ ```bibtex
173
+ @dataset{springwang08_hanoi_hcmc_real_estate,
174
+ author = {Xuan Quang Vo},
175
+ title = {Hanoi \& Ho Chi Minh City Real Estate Dataset},
176
+ year = {2026},
177
+ publisher = {Hugging Face},
178
+ url = {https://huggingface.co/datasets/SpringWang08/hanoi-hcmc-real-estate}
179
+ }
180
  ```
181
 
182
+ ## Acknowledgement
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
183
 
184
+ This dataset card and processed release were prepared as part of the **PropertyVision BI** project for academic, portfolio, and demonstration purposes.
 
clean_dataset.csv ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b5d523121a35db3987fd8b5eff64758bcd7c11a5c085878119211eef213fa600
3
+ size 28136118
raw/clean_data.csv ADDED
The diff for this file is too large to render. See raw diff
 
raw/clean_hanoi.csv ADDED
The diff for this file is too large to render. See raw diff