Browse Source

update readme, add description

Yuxuan Xie 1 year ago
parent
commit
23690bb0f1
1 changed files with 24 additions and 2 deletions
  1. 24 2
      README.md

+ 24 - 2
README.md

@@ -1,7 +1,16 @@
-# EBPM
+# EBPM - Eye Blink Prototype Matching
+This work presents a novel method for detecting eye blinking by establishing *eye state prototypes* to match blink patterns within eye aspect ratio (EAR) time series. In contrast to traditional methods, which mainly focus on the binary ON/OFF of blinkings, our method takes care of important diagnostic details such as blink speed, duration as well as inter-eye synchronicity. In an unsupervised manner, we learned prototypes from the existing blink patterns and established manually defined prototypes. Our research shows that both *unsupervised learned* and *manually defined prototypes* can reliably detect blink intervals and have comparable results, which offers potential diagnostic tools for identifying muscular or neural disorders. 
 
-## Setup
+Under the principle of the "minimal working prototype", our aim is to establish the eye blink prototype with a minimum amount of work, enabling medical professionals without computer expertise to easily create their own prototypes to match specific patterns. This repository presents the source code of our approach and provides a demonstration in sample experiments. 
 
+## Get Started
+### Setup
+1. clone the repository
+```bash
+git clone 
+```
+2. `cd` to EBPM
+3. setup
 ```bash
 conda create -n ebpm python=3.10 -y
 conda activate ebpm
@@ -9,3 +18,16 @@ conda activate ebpm
 pip install jupyter
 pip install -e .
 ```
+## Usage
+### Data
+### Prototypes
+### Experiments
+
+## Citation
+TODO
+## License
+Licensed uner [MIT](Licensed.txt).
+## Aknowledgements
+TODO: stumpy, mediapipe, jefapato, curly brace...more?
+## Contact
+For any queries, please reach out to [Yuxuan Xie] at [yuxuan.xie@uni-jena.de] or [Tim Büchner] at [tim.buechner@uni-jena.de].