Add 'README.md'

This commit is contained in:
Piotr Biskup 2022-02-16 10:14:52 +01:00
parent 3bd9baeec8
commit 57ba224358

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Face Mask Detection
1. Clone repository
2. Download dataset from: https://www.kaggle.com/andrewmvd/face-mask-detection
3. In the project create folder 'data'
4. Put 'annotations' and 'images' folders into 'data' folder
5. You can now run project (it uses saved model 'face_mask_detection2.hp') or you can train model yoursel and to do that:
- execute jupyter notebook 'data_preprocessing.ipynb' - data preprocessing
- execute jupyter notebook 'train_model.ipynb' - it will overwrite face_mask_detection2.hp' file
- run project
To run project:
```
pip3 install virtualenv
virtualenv venv
source venv/bin/activate
python3 -m pip install -r requirements.txt
python3 detect_mask.py
```