Skip to content

Commit db92068

Browse files
authored
docs: add README.md for HousePricePrediction
1 parent 8597442 commit db92068

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/HousePricePrediction/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# House Price Prediction (Jarvis)
2+
3+
This is a small, self-contained house price prediction example (Level 2). It includes:
4+
- A reproducible training & evaluation script (`housePricePrediction.py`).
5+
- Optional Streamlit demo (`housePricePrediction_streamlit.py`).
6+
- A tiny example dataset in `examples/` for quick smoke tests.
7+
8+
**Dataset:** Use the included sample for quick tests. For full training, the maintainer should download the full **Ames Housing dataset** (link provided below).
9+
10+
## How to run (quick)
11+
1. Create and activate a virtual environment:
12+
```bash
13+
python -m venv .venv
14+
source .venv/bin/activate
15+
```
16+
2. Install dependencies:
17+
```bash
18+
pip install -r requirements.txt
19+
```
20+
3. Run training + evaluation:
21+
```bash
22+
python housePricePrediction.py
23+
```
24+
4. Optional streamlit demo:
25+
```bash
26+
streamlit run housePricePrediction_streamlit.py
27+
```
28+
## Dataset links
29+
- Ames Housing dataset on Kaggle (recommended): https://www.kaggle.com/c/house-prices-advanced-regression-techniques
30+
*(NOTE: Do not commit large model files (like `house_price_model_joblib.pkl`) or the full dataset.)*

0 commit comments

Comments
 (0)