davidkariuki commited on
Commit
33588ad
1 Parent(s): 7ef0172

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -0
README.md CHANGED
@@ -1,3 +1,39 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+
5
+ README
6
+ Introduction
7
+ This repository contains a Gradient Boosting Regressor model trained to predict house rents. The model was trained on a dataset that was preprocessed and cleaned to ensure the best possible predictions.
8
+
9
+ Getting Started
10
+ These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
11
+
12
+ Prerequisites
13
+ You need Python 3.7 or later to run the scripts. You can have multiple Python versions (2.x and 3.x) installed on the same system without problems.
14
+
15
+ In Ubuntu, Mint and Debian you can install Python 3 like this: sudo apt-get install python3 python3-pip
16
+
17
+ For other Linux flavors, macOS, and Windows, packages are available at
18
+
19
+ https://www.python.org/getit/
20
+
21
+ Required Python Packages
22
+ You will also need the following Python packages:
23
+
24
+ pandas
25
+ sklearn
26
+ joblib
27
+ These can be installed using pip: pip install pandas sklearn joblib
28
+
29
+ Cloning the Repository
30
+ To clone this repository, run the following command in your terminal:
31
+ git clone <repository-link>
32
+
33
+ Running the Script
34
+ To use the model to predict house rents, run the predict.py script. You will be asked to input data for 'Area' and 'Suburb'. The script will then print the predicted rent.
35
+
36
+ To run the script: python test.py
37
+
38
+
39
+