Diff of /README.md [000000] .. [74ff45]

Switch to unified view

a b/README.md
1
# ECG classification
2
This project aims to use machine learning algorithms(emphasis on Deep Learning) to classify/detect anomalies in ECG signals.
3
4
5
### Requirements
6
1. Python 3
7
2. tensorflow/tensorflow-gpu (cnn.py tested with 1.13.1 and cnn_tf2.py tested with 2.5.0)
8
3. wfdb (tested with version 10.6.2)
9
10
11
### Wfdb dataset setup
12
 - You can find the full wfdb documentation [here](https://www.physionet.org/content/wfdb)
13
 - After downloading the wfdb tool and installing it, add the bin/rdsamp to your PATH for the fetch_data.py script to use it
14
15
### Usage
16
 - After the wfdb command is available generate the datasets using:
17
    ```sh
18
    $ python fetch_data.py
19
    ```
20
 - Install tensorflow and dependencies using the below command(installs tf without gpu support) or you can find other ways of installing [here](https://www.tensorflow.org/install/)
21
    ```sh
22
    $ pip install -r requirements.txt
23
    ```
24
 - Run CNN model using Tensorflow 1:
25
    ```sh
26
    $ python cnn.py
27
    ```
28
 - Run CNN model using Tensorflow 2:
29
    ```sh
30
    $ python cnn_tf2.py
31
    ```
32
33
34
### Remarks
35
* Installing and setting up wfdb is probably the most error prone thing in using this project. Make sure that you have access to rdsamp in the current shell before executing fetch_data.py
36
* Old implementation can be found in the old_keras_impl directory, but as far as I know it doesn't work.
37
* Still needs more optimization(try different hyperparameters)
38
* You can find the Tensorflow 2.0 implementation in tensorflow_impl/cnn_tf2.py
39
40
41
### TODO
42
- [ ] Add RNN/ResNet models
43
- [x] Add precision and recall metrics
44
- [ ] Add more diseases
45
- [x] Tensorflow 2.0
46