Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ruben Abbou's approach to Idoven's interview task #3

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions ruben-solution/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

data/

.DS_Store
/.Trash-0/
/package.json
/package-lock.json
/node_modules/
12 changes: 12 additions & 0 deletions ruben-solution/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM python:3.9-slim
WORKDIR /app
COPY . /app

RUN pip install --upgrade pip
RUN pip install --no-cache-dir -r requirements.txt

EXPOSE 8888

ENV PYTHONUNBUFFERED=1

CMD ["jupyter", "lab", "--ip=0.0.0.0", "--port=8888", "--no-browser", "--allow-root"]
74 changes: 74 additions & 0 deletions ruben-solution/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Idoven ECG analysis Project

---

This repository contains the code and data for an ECG analysis project, focusing on distinguishing between Normal and Abnormal ECGs using machine learning models. The project is organized into various directories and notebooks that guide you through the entire process, from data exploration to model training and evaluation.

## Project Structure

### 1. `data/`
- **raw/**: Contains the raw ECG data files.
- **processed/**: Stores the preprocessed data that is ready for model training.

### 2. `models/`
- `cnn_model.keras`: The best trained Convolutional Neural Network (CNN) model.
- `resnet_model.keras`: The best trained ResNet model.

### 3. `notebooks/`
- **01-data-exploration.ipynb**: Notebook for initial data exploration and visualization.
- **02-data-preprocessing.ipynb**: Notebook detailing the preprocessing steps applied to the ECG data.
- **03-model-training.ipynb**: Notebook used to train the CNN and ResNet models.
- **04-results-analysis.ipynb**: Notebook for analyzing the results, including model evaluation metrics and visualizations.

### 4. `reports/`
- `cnn_history.pkl`: Training history of the CNN model.
- `resnet_history.pkl`: Training history of the ResNet model.
- `coutour_plot.png`: Contour plot of the hyperparameter optimization.
- `parameter_importances.png`: Visualization of feature importances or parameter impact.
- `tscnn_hyperparameter_study.pkl`: Study results on hyperparameter tuning.

### 5. `results/`
- `cnn_preds.npy`: Numpy array containing the predictions from the CNN model.
- `resnet_preds.npy`: Numpy array containing the predictions from the ResNet model.

### 6. `src/`
- **models/**: Contains model definitions and scripts for training and evaluation.
- **utils/**: Utility scripts used across the project.
- `data_preprocessing.py`: Functions for preprocessing ECG data.
- `ecg_visualization.py`: Functions for visualizing ECG data.
- `example_physionet.py`: Example script for working with PhysioNet data.
- `hyperparameter_tuning.py`: Script for hyperparameter tuning of models.

### 7. **Setup and Configuration Files**
- **Dockerfile**: Docker configuration file to set up the environment.
- **requirements.txt**: List of Python dependencies required for the project.
- **setup.py**: Script to install the `ecg_analysis` package.
- **.gitignore**: Specifies files and directories to be ignored by Git.
- **README.md**: This README file.

## Getting Started

### Prerequisites
Ensure you have Docker installed on your system. Alternatively, you can manually install the required Python packages listed in `requirements.txt`.

### Installation

```bash
docker build -t ecg-analysis .
docker run -p 8888:8888 ecg-analysis
```
This will set up a Jupyter Lab server with the project environment.

### Usage

1. **Data Exploration**:
Open the `01-data-exploration.ipynb` notebook to explore the dataset and visualize ECG signals.

2. **Data Preprocessing**:
Use `02-data-preprocessing.ipynb` to preprocess the raw ECG data and prepare it for model training.

3. **Model Training**:
The `03-model-training.ipynb` notebook guides you through training both CNN and ResNet models on the processed data.

4. **Results Analysis**:
Evaluate model performance and analyze results in the `04-results-analysis.ipynb` notebook.
Empty file added ruben-solution/__init__.py
Empty file.
Binary file added ruben-solution/models/cnn_model.keras
Binary file not shown.
Binary file added ruben-solution/models/resnet_model.keras
Binary file not shown.
Loading