Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Anwar, Malik Aqeel committed Aug 5, 2020
1 parent e11fcb7 commit 9bd8457
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
2 changes: 2 additions & 0 deletions mask_the_face.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
# 4. Done: Organize and Upload MFR2 dataset
# 5. Done: Dlib based detector
# 6. Done: Download dlib model
# 7. Readme update with --code etc
# 8. Update website

# Command-line input setup
parser = argparse.ArgumentParser(
Expand Down
11 changes: 11 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ python mask_the_face.py --path 'data/office.jpg' --mask_type 'N95' --verbose
| verbose | If set to True, will be used to display useful messages during masking |
|write_original_image| If used, the original unmasked image will also be saved in the masked image folder along with processed masked image |

### Explanation:
#### --code
the --code argument can be used to apply different type of masks uniformly at random to the images in the dataset.
```
# Generic format
--code < masktype1 >-< color as hex or texture file path >, < masktype2 >-< color as hex or texture file path>, ...
# Example
--code cloth-masks/textures/check/check_4.jpg, cloth-#e54294, cloth-#ff0000, cloth, cloth-masks/textures/others/heart_1.png, cloth-masks/textures/fruits/pineapple.png, N95
```
The example above will apply 7 different masks, uniform at random, to be applied to the selected face dataset (via --path argument).
## Frequently Asked Questions (FAQ)
Click [here](faq.md) to troubleshoot errors faced while installing and running MaskTheFace

Expand Down

0 comments on commit 9bd8457

Please sign in to comment.