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

feat: Deploy latest version of Gradio app

Browse files
Files changed (1) hide show
  1. README.md +8 -70
README.md CHANGED
@@ -1,9 +1,8 @@
1
- title: Predictive Maintenance for Turbofan Engines emoji: ✈️ colorFrom: blue colorTo: indigo sdk: gradio sdk_version: 4.20.0 app_file: app.py pinned: false
2
-
3
  Predictive Maintenance for Turbofan Engines
4
  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.
5
 
6
- 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 a Hugging Face Space.
7
 
8
  ✨ Features
9
  Interactive Demo: A user-friendly Gradio web interface to get real-time RUL predictions.
@@ -12,74 +11,13 @@ Automated CI/CD: The model is automatically retrained and the application is red
12
 
13
  Reproducible Environment: A defined development environment using Codespaces ensures that the project can be run consistently by anyone.
14
 
15
- 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.
16
-
17
- 🛠️ Technology Stack
18
- Backend: Python
19
-
20
- ML Model: Scikit-learn (Linear Regression)
21
-
22
- Web App: Gradio
23
-
24
- Dev Environment: GitHub Codespaces (Docker)
25
-
26
- CI/CD & Hosting: GitHub Actions, Hugging Face Spaces
27
-
28
- 🚀 How to Run Locally
29
- To run this project on your own machine or Codespace, follow these steps.
30
-
31
- Prerequisites
32
- Python 3.9 or higher
33
-
34
- Git
35
-
36
- 1. Clone the Repository
37
- git clone [https://github.com/ashandilgith/predictivemaintenance-.git](https://github.com/ashandilgith/predictivemaintenance-.git)
38
- cd predictivemaintenance-
39
-
40
- 2. Set Up a Virtual Environment (Recommended)
41
- # Create a virtual environment
42
- python3 -m venv venv
43
-
44
- # Activate it
45
- source venv/bin/activate
46
-
47
- 3. Install Dependencies
48
- Install all the required Python libraries from the requirements.txt file.
49
-
50
- pip install -r requirements.txt
51
-
52
- 4. Prepare the Data
53
- Run the script to process the raw dataset. This will create processed_train_data.csv in the data/ directory.
54
-
55
- python prepare_data.py
56
-
57
- 5. Train the Model
58
- Run the training script to create the model.joblib file.
59
-
60
- python train.py
61
-
62
- 6. Launch the Gradio App
63
- Run the application file. The app will be available at a local URL shown in your terminal.
64
-
65
- python app.py
66
-
67
- ⚙️ CI/CD Pipeline
68
- This project uses a GitHub Actions workflow defined in .github/workflows/main.yml. The pipeline automates the following steps on every push to the main branch:
69
-
70
- Checkout Code: Clones the repository onto a fresh virtual machine.
71
-
72
- Install Dependencies: Installs all necessary libraries.
73
-
74
- Prepare Data: Runs the data preparation script.
75
-
76
- Train Model: Trains the linear model and creates the model.joblib artifact.
77
 
78
- Deploy to Space: Pushes the entire application, including the newly trained model, to the designated Hugging Face Space, making the updated app live.
79
 
80
- 📊 Dataset
81
- This project uses the Turbofan Engine Degradation Simulation Data Set provided by NASA.
82
 
83
- Source: NASA Prognostics Data Repository
84
 
85
- Subset Used: FD001
 
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.
 
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.