Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruban2205/housing-prediction-microservice
This repository houses a microservice designed for predicting housing prices based on machine learning models. It provides a REST API endpoint to interact with the prediction service, making it easy to integrate into various applications.
https://github.com/ruban2205/housing-prediction-microservice
machine-learning python streamlit
Last synced: 3 days ago
JSON representation
This repository houses a microservice designed for predicting housing prices based on machine learning models. It provides a REST API endpoint to interact with the prediction service, making it easy to integrate into various applications.
- Host: GitHub
- URL: https://github.com/ruban2205/housing-prediction-microservice
- Owner: Ruban2205
- License: mit
- Created: 2023-07-25T04:36:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-15T06:08:26.000Z (8 months ago)
- Last Synced: 2024-12-18T07:01:47.482Z (about 2 months ago)
- Topics: machine-learning, python, streamlit
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Housing Prediction Microservice
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[contributors-shield]: https://img.shields.io/github/contributors/Ruban2205/housing-prediction-microservice.svg?style=for-the-badge
[contributors-url]: https://github.com/Ruban2205/housing-prediction-microservice/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Ruban2205/housing-prediction-microservice.svg?style=for-the-badge
[forks-url]: https://github.com/Ruban2205/housing-prediction-microservice/network/members
[stars-shield]: https://img.shields.io/github/stars/Ruban2205/housing-prediction-microservice.svg?style=for-the-badge
[stars-url]: https://github.com/Ruban2205/housing-prediction-microservice/stargazers
[issues-shield]: https://img.shields.io/github/issues/Ruban2205/housing-prediction-microservice.svg?style=for-the-badge
[issues-url]: https://github.com/Ruban2205/housing-prediction-microservice/issues
[license-shield]: https://img.shields.io/github/license/Ruban2205/housing-prediction-microservice.svg?style=for-the-badge
[license-url]: https://github.com/Ruban2205/housing-prediction-microservice/blob/main/LICENSE
This repository contains a microservice for predicting housing prices based on machine learning models.
## Overview
This microservice provides a REST API endpoint to predict housing prices. It utilizes a machine learning model trained on historical housing data to make predictions.
## Installation
1. To run this microservice locally, follow these steps:
```bash
git clone https://github.com/Ruban2205/housing-prediction-microservice.git
cd housing-prediction-microservice
```
2. Install dependencies:
```
pip install -r requirements.txt
```
3. Start the microservice
```
python app.py
```
The microservice will start running locally at `http://localhost:5000`
## API Usage
**Endpoint**
- POST `/predict`
**Request Body**
The `/predict` endpoint expects a JSON object with the following format:
```json
{
"area": 1500,
"rooms": 3,
"age": 15
}
```
- `area` (integer): The area of the house in square feet.
- `rooms` (integer): The number of rooms in the house.
- `age` (integer): The age of the house in years.
**Response**
The endpoint responds with a JSON object containing the predicted price:
```json
{
"predicted_price": 250000
}
```
## Contributing
Thank you for considering contributing to the Housing Prediction Microservice! Please follow these guidelines:
1. **Reporting Bugs**: Search existing issues before reporting bugs.
2. **Enhancements**: Suggest new features or improvements via GitHub issues.
3. **Code Contributions**: Fork the repo, create a branch, and submit a pull request.
4. **Pull Requests**: Ensure tests are added for new code. Get a sign-off before merging.
## Deployment
For deployment, ensure to set the necessary environment variables and configure the microservice to run in a production environment. This typically involves using a production-grade WSGI server like Gunicorn and setting up appropriate logging.
## License
This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
Star ⭐ this repository for Future use 😊