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

Update README.md

This commit is contained in:
Shawn Shan 2020-09-29 22:01:54 -05:00 committed by GitHub
parent e3b2181949
commit 7abf1dbc28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,8 +13,6 @@ Copyright
---------
This code is intended only for personal privacy protection or academic research.
We are currently exploring the filing of a provisional patent on the Fawkes algorithm.
Usage
-----
@ -60,6 +58,15 @@ pip install fawkes
If you don't have root privilege, please try to install on user namespace: `pip install --user fawkes`.
Academic Research Usage
-----------------------
For academic researchers, whether seeking to improve fawkes or to explore potential vunerability, please refer to the following guide to test Fawkes.
To protect a class in a dataset, first move the label's image to a seperate location and run Fawkes. Please use `--debug` option and set `batch-size` to a reasonable number (i.e 16, 32). If the images are already cropped and aligned, then also use the `no-align` option.
Contribute to Fawkes
--------------------