Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grampers-dev/co2oracle
The CO2 Oracle project uses machine learning and AI to analyze and predict CO2 emissions for environmental management. Using a Kaggle dataset, it demonstrates predictive analytics to understand and forecast emissions. Written in Python, it employs libraries like Pandas, NumPy, and Scikit-Learn.
https://github.com/grampers-dev/co2oracle
artificial-intelligence machine-learning numpy pandas python scikit-learn
Last synced: 27 days ago
JSON representation
The CO2 Oracle project uses machine learning and AI to analyze and predict CO2 emissions for environmental management. Using a Kaggle dataset, it demonstrates predictive analytics to understand and forecast emissions. Written in Python, it employs libraries like Pandas, NumPy, and Scikit-Learn.
- Host: GitHub
- URL: https://github.com/grampers-dev/co2oracle
- Owner: Grampers-Dev
- Created: 2024-08-02T23:07:41.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T22:06:37.000Z (2 months ago)
- Last Synced: 2024-09-22T06:30:57.484Z (about 2 months ago)
- Topics: artificial-intelligence, machine-learning, numpy, pandas, python, scikit-learn
- Language: Jupyter Notebook
- Homepage:
- Size: 13.7 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CO2Oracle 🌍💨
## Index
- [CO2Oracle 🌍💨](#co2oracle-)
- [Index](#index)
- [1. Dataset Content 📊](#1-dataset-content-)
- [1.1 Dataset Structure 🏗️](#11-dataset-structure-️)
- [1.2 Included Information 📝](#12-included-information-)
- [2. Project Terminology \& Jargon 🔍](#2-project-terminology--jargon-)
- [3. Business Requirements 🎯](#3-business-requirements-)
- [3.1 Understanding Emission Patterns 📈](#31-understanding-emission-patterns-)
- [3.2 Predictive Modeling for Emissions 🔮](#32-predictive-modeling-for-emissions-)
- [4. Hypothesis and Validation Approach 🧪](#4-hypothesis-and-validation-approach-)
- [4.1 Hypothesis: CO2 Emissions are Increasing Over Time](#41-hypothesis-co2-emissions-are-increasing-over-time)
- [4.2 Hypothesis: Cement Production is a Major Contributor to CO2 Emissions](#42-hypothesis-cement-production-is-a-major-contributor-to-co2-emissions)
- [5. Mapping Business Requirements to Data Visualizations and ML Tasks 🗺️](#5-mapping-business-requirements-to-data-visualizations-and-ml-tasks-️)
- [5.1 Business Requirement 1: Data Visualization and Correlation Study](#51-business-requirement-1-data-visualization-and-correlation-study)
- [5.2 Business Requirement 2: Predictive Modeling and Cluster Analysis](#52-business-requirement-2-predictive-modeling-and-cluster-analysis)
- [6. ML Business Case 🤖](#6-ml-business-case-)
- [6.1 Predicting CO2 Emissions 📉](#61-predicting-co2-emissions-)
- [6.1.1 Classification Model](#611-classification-model)
- [6.1.2 Predicting Emission Levels](#612-predicting-emission-levels)
- [Regression Model](#regression-model)
- [6.1.3 Classification Model for Emission Duration](#613-classification-model-for-emission-duration)
- [6.2 Cluster Analysis 🔢](#62-cluster-analysis-)
- [6.2.1 Clustering Model](#621-clustering-model)
- [7. Deployment 🚀](#7-deployment-)
- [7.1 Heroku](#71-heroku)
- [8. Main Data Analysis and Machine Learning Libraries 🛠️](#8-main-data-analysis-and-machine-learning-libraries-️)
- [8.1 Main Machine Learning libraries used:](#81-main-machine-learning-libraries-used)
- [9. Run locally 💻](#9-run-locally-)
## 1. Dataset Content 📊
The dataset is sourced from [Kaggle](https://www.kaggle.com/datasets/thedevastator/global-fossil-co2-emissions-by-country-2002-2022/data). I have created a fictitious scenario to demonstrate how predictive analytics can be applied in a real-world project.
### 1.1 Dataset Structure 🏗️
- **Rows:** Each row represents a data record.
- **Columns:** Each column contains an attribute related to CO2 emissions.
### 1.2 Included Information 📝
- **Emission Sources:** Data on CO2 emissions from various sources such as cement production, coal combustion, gas combustion, oil combustion, gas flaring, and other sources.
- **Temporal Data:** Yearly data capturing the changes in CO2 emissions over time.
- **Geographical Data:** Information on the country where the emissions were recorded.
| Variable | Meaning | Units |
|-------------------|----------------------------------------------------------------|-------------------------------------------------------------------------------------|
| Country | Country where CO2 emissions are recorded | Country name |
| Year | Year of the CO2 emission data | Year (e.g., 1990, 2000) |
| Cement | CO2 emissions from cement production | Metric tons (t) |
| Coal | CO2 emissions from coal combustion | Metric tons (t) |
| Gas | CO2 emissions from natural gas combustion | Metric tons (t) |
| Oil | CO2 emissions from oil combustion | Metric tons (t) |
| Flaring | CO2 emissions from gas flaring | Metric tons (t) |
| Other | CO2 emissions from other sources | Metric tons (t) |
## 2. Project Terminology & Jargon 🔍
In the CO2 Oracle project, specific terms and definitions pertinent to the analysis of CO2 emissions data include:
- **Emission Sources:** Various sources contributing to CO2 emissions such as cement production, coal combustion, gas combustion, oil combustion, gas flaring, and other sources.
- **Temporal Data:** Yearly data capturing changes in CO2 emissions over time.
- **Geographical Data:** Information on the country where CO2 emissions were recorded.
## 3. Business Requirements 🎯
As a Data Analyst at CO2 Oracle, I have been engaged by a Government Agency to provide actionable insights and data-driven recommendations. The objective is to manage CO2 emissions effectively and understand how different sources contribute to the overall emissions. The client has shared the data spanning multiple years and various emission sources.
### 3.1 Understanding Emission Patterns 📈
The client aims to comprehend the patterns in CO2 emissions from different sources. They are particularly interested in identifying the most relevant variables that correlate with changes in emissions over time.
### 3.2 Predictive Modeling for Emissions 🔮
The client wants to determine whether certain factors can predict changes in CO2 emissions accurately. Specifically, they are interested in:
- Identifying which factors can move a source with moderate predictive power, like 'Flaring', to a more predictable category.
## 4. Hypothesis and Validation Approach 🧪
### 4.1 Hypothesis: CO2 Emissions are Increasing Over Time
I suspect that CO2 emissions from various sources have been increasing over the years.
- **Validation Approach:** Conduct a correlation study (Spearman and Pearson) to investigate the relationship between 'Year' and CO2 emissions from different sources (Coal, Oil, Gas, Cement, Flaring, Other).
### 4.2 Hypothesis: Cement Production is a Major Contributor to CO2 Emissions
My analysis suggests that emissions from cement production are significantly correlated with the year.
- **Validation Approach:** Use a correlation study and PPS (Predictive Power Score) to validate this hypothesis. This will help determine the strength and nature of the relationship between 'Year' and 'Cement' emissions.
## 5. Mapping Business Requirements to Data Visualizations and ML Tasks 🗺️
### 5.1 Business Requirement 1: Data Visualization and Correlation Study
- **Objective:** Analyze the data to uncover significant patterns and correlations among different CO2 emission sources.
- **Approach:**
- Inspect the data related to CO2 emissions from different sources.
- Conduct a correlation study (Spearman and Pearson) to understand how variables like 'Year' and 'Country' correlate with different emission sources.
- Visualize the main variables against CO2 emissions to derive insights.
- **Deliverables:**
- Correlation Heatmaps: Visual representations of the Spearman and Pearson correlations.
- Detailed analysis of how each source contributes to the total emissions and identification of key variables influencing these emissions.
### 5.2 Business Requirement 2: Predictive Modeling and Cluster Analysis
- **Objective:** Develop predictive models to forecast future CO2 emissions and understand the characteristics of different emission sources.
- **Approach:**
- **Time Series Analysis:** Build models using historical 'Year' data to predict future emissions for key sources.
- **Classification and Regression:** Develop models to predict whether certain sources will have higher emissions in the future and to forecast specific emission levels.
- **Cluster Analysis:** Segment emission sources into clusters based on their characteristics and predictive factors. Identify key factors that influence a source's membership in a cluster.
- **Cluster Profiling:** Analyze the clusters to present potential strategies to manage emissions and reduce environmental impact.
- **Deliverables:**
- **Forecast Models:** Time series models predicting future emissions based on historical data.
- **Cluster Analysis Report:** Identification of clusters and the factors influencing their membership.
- **Predictive Insights:** Recommendations on how to manage and reduce CO2 emissions by targeting key predictive factors.
## 6. ML Business Case 🤖
### 6.1 Predicting CO2 Emissions 📉
#### 6.1.1 Classification Model
I aim to develop an ML model to predict whether CO2 emissions from specific sources will increase or decrease based on historical data. The target variable is categorical, representing the two classes: increase (1) or decrease (0). This model will be a supervised, binary classification model.
- **Objective:** Provide insights to environmental analysts to manage and mitigate CO2 emissions effectively.
- **Success Metrics:**
- Achieve at least 80% recall for predicting increases in emissions on both the training and test sets.
- The model will be considered a failure if:
- After three months of deployment, more than 30% of predicted increases in emissions are incorrect.
- The precision for predicting decreases in emissions is lower than 80% on both the training and test sets.
- **Model Output:** A flag indicating whether CO2 emissions will increase or decrease, along with the associated probability. Predictions will be made in real-time, based on input data provided by environmental analysts.
- **Current Approach:** No existing method to predict changes in CO2 emissions.
- **Training Data:** Historical data on CO2 emissions, excluding non-predictive variables like unique identifiers.
#### 6.1.2 Predicting Emission Levels
##### Regression Model
I want to develop an ML model to predict future emission levels for sources expected to increase in emissions. The target variable is continuous, representing emission levels.
- **Objective:** Provide insights to environmental analysts to manage and mitigate CO2 emissions effectively.
- **Success Metrics:**
- Achieve an R2 score of at least 0.7 on both the training and test sets.
- The model will be considered a failure if:
- After 12 months of deployment, more than 30% of predictions are off by more than 50%.
- **Model Output:** A continuous value representing predicted emission levels. Predictions will be made in real-time.
- **Current Approach:** No existing method to predict emission levels.
- **Training Data:** Historical data on CO2 emissions, filtered to include only instances where emissions increased, excluding non-predictive variables like unique identifiers.
#### 6.1.3 Classification Model for Emission Duration
Before finalizing MY approach, I considered a regression model to predict the duration of emission increases but did not meet the performance requirements (at least 0.7 R2 score). Instead, I converted this task to a classification problem by discretizing the target into three ranges: <4 months, 4-20 months, and >20 months.
- **Objective:** Provide insights to environmental analysts on the duration of emission increases.
- **Success Metrics:**
- Achieve at least 0.8 recall for predicting increases lasting <4 months on both the training and test sets.
- The model will be considered a failure if:
- After three months of deployment, more than 30% of predictions for <4 months are incorrect.
- **Model Output:** A class representing the range of emission increase duration. Predictions will be made in real-time.
- **Current Approach:** No existing method to predict emission increase duration.
- **Training Data:** Historical data on CO2 emissions, filtered to include only instances where emissions increased, excluding non-predictive variables like unique identifiers.
### 6.2 Cluster Analysis 🔢
#### 6.2.1 Clustering Model
I aim to develop an ML model to cluster similar emission sources based on their characteristics. This is an unsupervised learning task.
- **Objective:** Provide insights to environmental analysts for better management of CO2 emissions.
- **Success Metrics:**
- Achieve an average silhouette score of at least 0.45.
- The model will be considered a failure if it suggests more than 15 clusters, making it impractical to interpret.
- **Model Output:** A categorical variable representing cluster membership, appended to the dataset.
- **Current Approach:** No existing method to group similar emission sources.
- **Training Data:** Historical data on CO2 emissions, excluding non-predictive variables like unique identifiers and emissions totals.
## 7. Deployment 🚀
This project was deployed to [Heroku](https://heroku.com/) using the following steps:
1. Log in to Heroku and create an App.
2. At the Deploy tab, select GitHub as the deployment method.
3. Select your repository name and click Search. Once it is found, click Connect.
4. Select the branch you want to deploy, then click Deploy Branch.
5. The deployment process should happen smoothly if all deployment files are fully functional. Click now the button Open App on the top of the page to access your App.
### 7.1 Heroku
- The App live link is: `https://YOUR_APP_NAME.herokuapp.com/`
- Set the runtime.txt Python version to a [Heroku-20](https://devcenter.heroku.com/articles/python-support#supported-runtimes) stack currently supported version.
- The project was deployed to Heroku using the following steps.
1. Log in to Heroku and create an App.
2. At the Deploy tab, select GitHub as the deployment method.
3. Select your repository name and click Search. Once it is found, click Connect.
4. Select the branch you want to deploy, then click Deploy Branch.
5. The deployment process should happen smoothly if all deployment files are fully functional. Click the button Open App on the top of the page to access your App.
## 8. Known Issues and Bug Reports 🐛
During the development and deployment of the CO2Oracle project, the following issues have been identified. Future examination and debugging will be required to address these:
### 8.1 Heatmap Display Issue
- **Issue:** Some numeric values do not appear in the heatmap when displayed on the Streamlit app, even though they are correctly rendered in the Jupyter Notebook environment.
- **Possible Cause:** The exact cause is unclear but could be related to differences in how Streamlit and Jupyter handle data types or render visualizations. It's also possible that certain preprocessing steps or environmental factors (like package versions) contribute to this issue.
- **Future Work:** Further investigation is needed to understand how Streamlit processes data and renders visualizations compared to Jupyter. This might involve revisiting data cleaning steps, ensuring that all numeric columns are properly handled, or debugging the visualization libraries (Seaborn, Matplotlib) in the Streamlit environment.
### 8.2 Cluster Analysis Performance
- **Issue:** The Streamlit app page that performs cluster analysis is noticeably laggy and slow to load, although it does eventually complete the operation.
- **Possible Cause:** The performance issue likely stems from the computational intensity of the cluster analysis, especially when dealing with large datasets or complex clustering algorithms.
- **Future Work:** Optimize the cluster analysis process by potentially simplifying the data, using more efficient algorithms, or pre-processing the data to reduce its size and complexity. Consider implementing parallel processing or other performance enhancements to make the Streamlit app more responsive and user-friendly.
## 9. Main Data Analysis and Machine Learning Libraries 🛠️
- **Numpy:**
- For efficient calculations on large datasets, particularly pixel data.
- Normalizing pixel data.
- Calculating means and standard deviations.
- Serving as a foundation for other data analysis and machine learning libraries.
- **Pandas:**
- Utilized mainly for managing data with pandas DataFrames.
- **Matplotlib & Seaborn:**
- Used for data visualization, including plotting and displaying images from pixel data.
- Generating metric plots and histograms.
### 9.1 Main Machine Learning libraries used:
- **Scikit Learn:**
- Utilized for hyperparameter optimization through GridSearchCV.
## 10. Run locally 💻
This repo covers the entire process of creating a ML model. From collecting and processing the data to conducting hyperparameter optimization, data augmentation, defining, and training the model on the data.
__To use this repo, follow these steps:__
1. Fork or clone this repository.
2. Install dependencies by running:
```bash
pip install -r "requirements-dev.txt"
```
3. Register an account with [Kaggle](https://www.kaggle.com/) and create a new API token, download the kaggle.json and place it in the project's root directory.
4. Run the notebooks in the jupyter_notebooks folder in the specified order:
- __DataCollection.ipynb:__ Downloads the dataset and extracts the specified number of images.
- __DataVisualization.ipynb:__ Conducts studies on the data and saves insightful plots.
- __Model.ipynb:__ Prepares data, performs data augmentation and hyperparameter optimization, defines model architecture, trains, evaluates, and saves an ML model.
5. Start the web app by running:
```bash
streamlit run Home.py
```