GitHub Actions Bot commited on
Commit
e52ec48
·
1 Parent(s): 415d9b9

feat: Deploy latest version of Gradio app

Browse files
Files changed (1) hide show
  1. README.md +38 -12
README.md CHANGED
@@ -1,23 +1,49 @@
1
- title: Predictive Maintenance for Turbofan Engines emoji: ✈️ colorFrom: blue colorTo: indigo sdk: gradio app_file: app.py pinned: false
2
- Predictive Maintenance for Turbofan Engines
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  A complete MLOps project demonstrating an end-to-end workflow for a predictive maintenance solution. This application uses a machine learning model to predict the Remaining Useful Life (RUL) of a turbofan engine based on operational settings and sensor data.
4
 
5
  The project is developed within a containerized GitHub Codespaces environment and features a CI/CD pipeline that automatically trains the model and deploys the application to this Hugging Face Space.
6
 
7
- ✨ Features
8
- Interactive Demo: A user-friendly Gradio web interface to get real-time RUL predictions.
 
 
 
 
 
 
9
 
10
- Automated CI/CD: The model is automatically retrained and the application is redeployed on every push to the main branch using GitHub Actions.
 
 
 
 
11
 
12
- Reproducible Environment: A defined development environment using Codespaces ensures that the project can be run consistently by anyone.
13
 
14
- ⚙️ How It Works
15
- This application is powered by a scikit-learn Linear Regression model trained on the NASA Turbofan Engine Degradation Simulation Data Set.
16
 
17
- The CI/CD pipeline automates the following steps:
18
 
19
- Prepare Data: Processes the raw dataset.
 
20
 
21
- Train Model: Trains the linear model and creates a model.joblib artifact.
22
 
23
- Deploy to Space: Pushes the entire application, including the newly trained model and this README, to this Hugging Face Space to make the app live.
 
 
 
1
+ ---
2
+ title: Predictive Maintenance for Turbofan Engines
3
+ emoji: ✈️
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: gradio
7
+ sdk_version: 4.25.0
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # Predictive Maintenance for Turbofan Engines
13
+
14
+ [![Hugging Face Spaces](https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/ashandilgith/predictive_maintenance)
15
+ [![CI/CD Status](https://github.com/ashandilgith/predictivemaintenance-/actions/workflows/main.yml/badge.svg)](https://github.com/ashandilgith/predictivemaintenance-/actions)
16
+
17
  A complete MLOps project demonstrating an end-to-end workflow for a predictive maintenance solution. This application uses a machine learning model to predict the Remaining Useful Life (RUL) of a turbofan engine based on operational settings and sensor data.
18
 
19
  The project is developed within a containerized GitHub Codespaces environment and features a CI/CD pipeline that automatically trains the model and deploys the application to this Hugging Face Space.
20
 
21
+ ## ✨ Features
22
+
23
+ - **Interactive Demo:** A user-friendly Gradio web interface to get real-time RUL predictions.
24
+ - **Automated CI/CD:** The model is automatically retrained and the application is redeployed on every push to the `main` branch using GitHub Actions.
25
+ - **Reproducible Environment:** A defined development environment using Codespaces ensures that the project can be run consistently by anyone.
26
+ - **Extensible Framework:** While this demo uses a turbofan engine dataset, the principles can be customized for any machinery that relies on sensor data to predict performance or potential faults.
27
+
28
+ ## 🛠️ Technology Stack
29
 
30
+ - **Backend:** Python
31
+ - **ML Model:** Scikit-learn (Linear Regression)
32
+ - **Web App:** Gradio
33
+ - **Dev Environment:** GitHub Codespaces (Docker)
34
+ - **CI/CD & Hosting:** GitHub Actions, Hugging Face Spaces
35
 
36
+ ## 🚀 How to Run Locally
37
 
38
+ To run this project on your own machine or Codespace, follow these steps.
 
39
 
40
+ ### Prerequisites
41
 
42
+ - Python 3.9 or higher
43
+ - Git
44
 
45
+ ### 1. Clone the Repository
46
 
47
+ ```bash
48
+ git clone [https://github.com/ashandilgith/predictivemaintenance-.git](https://github.com/ashandilgith/predictivemaintenance-.git)
49
+ cd predictivemaintenance-