|
Download README.md from KLEB38/OC_P5_v2: direct link, hf CLI and curl.
- Browser
- Download file 1.53 kB
-
https://huggingface.co/KLEB38/OC_P5_v2/resolve/main/README.md
- Command line
-
hf download hf://KLEB38/OC_P5_v2/README.md
-
curl -L -o README.md https://huggingface.co/KLEB38/OC_P5_v2/resolve/main/README.md
1.53 kB
| license: apache-2.0 | |
| language: | |
| - en | |
| # HR Attrition Prediction API - Futurisys | |
| This project provides a professional-grade REST API designed to predict employee attrition for **Futurisys**. | |
| It uses a Machine Learning pipeline to analyze employee data and provide actionable insights for HR departments. | |
| ## Project Overview | |
| The objective is to identify employees at risk of leaving the company by analyzing HR features. | |
| **Key Features:** | |
| - **Machine Learning Pipeline:** A robust model (Gradient Boosting/Random Forest) integrated with automated preprocessing. | |
| - **FastAPI Framework:** High-performance API with built-in validation and asynchronous support. | |
| --- | |
| ## Project Structure | |
| ```text | |
| . | |
| βββ app/ | |
| β βββ main.py # Core API logic and Pydantic schemas | |
| β βββ pipeline_rh.joblib # Serialized Scikit-Learn pipeline (Model + Scalers) | |
| βββ notebooks/ # Research, EDA, and model training notebooks | |
| βββ .gitignore # Ensures clean version control by ignoring temp files | |
| βββ requirements.txt # List of Python dependencies | |
| βββ README.md # Project documentation | |
| ``` | |
| ## Installation & Setup | |
| 1. Prerequisites | |
| Python 3.8+ | |
| Git | |
| 3. Clone the Repository | |
| git clone <your-repository-url> | |
| cd <your-project-folder> | |
| 3. Install dependencies | |
| pip install -r requirements.txt | |
| ## Usage | |
| ### Running the API | |
| ## API Endpoints | |
| GET / | |
| POST /predict | |
| ## Author | |
| Kevin L. - Data Science & Machine Learning Student |