mirror of https://github.com/Shawn-Shan/fawkes.git synced 2024-12-22 07:09:33 +05:30

History

Shawn Shan 59c6fda67a Update README.md		2020-07-29 21:30:11 -05:00
..
__init__.py	0.3 software release	2020-07-29 16:42:16 -05:00
__main__.py	prepare for 0.3 release	2020-07-29 01:50:42 -05:00
align_face.py	prepare for 0.3 release	2020-07-29 01:50:42 -05:00
detect_faces.py	prepare for 0.3 release	2020-07-29 01:50:42 -05:00
differentiator.py	prepare for 0.3 release	2020-07-29 01:50:42 -05:00
protection.py	0.3 software release	2020-07-29 16:42:16 -05:00
README.md	Update README.md	2020-07-29 21:30:11 -05:00
utils.py	0.3 software release	2020-07-29 16:42:16 -05:00

README.md

Fawkes Binary

This application is built for individuals to cloak their images before uploading to the Internet. For more information about the project, please refer to our project webpage.

If you are a developer or researcher planning to customize and modify on our existing code. Please refer to fawkes.

How to Setup

MAC:

Download the binary following this link and unzip the download file.
Create a directory and move all the images you wish to protect into that directory. Note the path to that directory (e.g. ~/Desktop/images).
Open terminal and change directory to fawkes (the unzipped folder).
(If your MacOS is Catalina) Run sudo spctl --master-disable to enable running apps from unidentified developer. We are working on a solution to bypass this step.
Run ./protection-v0.3 -d IMAGE_DIR_PATH to generate cloak for images in IMAGE_DIR_PATH.
When the cloaked image is generated, it will output a *_min_cloaked.png image in IMAGE_DIR_PATH. The generation takes ~40 seconds per image depending on the hardware.

PC:

Download the binary following this link and unzip the download file.
Create a directory and move all the images you wish to protect into that directory. Note the path to that directory (e.g. ~/Desktop/images).
Open terminal(powershell or cmd) and change directory to protection (the unzipped folder).
Run protection-v0.3.exe -d IMAGE_DIR_PATH to generate cloak for images in IMAGE_DIR_PATH.
When the cloaked image is generated, it will output a *_min_cloaked.png image in IMAGE_DIR_PATH. The generation takes ~40 seconds per image depending on the hardware.

Linux:

Download the binary following this link and unzip the download file.
Create a directory and move all the images you wish to protect into that directory. Note the path to that directory (e.g. ~/Desktop/images).
Open terminal and change directory to protection (the unzipped folder).
Run ./protection-v0.3 -d IMAGE_DIR_PATH to generate cloak for images in IMAGE_DIR_PATH.
When the cloaked image is generated, it will output a *_min_cloaked.png image in IMAGE_DIR_PATH. The generation takes ~40 seconds per image depending on the hardware.

More details on the optional parameters check out the github repo.