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

Add pypi link to README

plus some *free* empty lines :)
This commit is contained in:
Viktor Szépe 2020-07-25 16:19:14 +02:00 committed by GitHub
parent edd7df5dc6
commit cbb5c1b6c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,6 +10,7 @@ If you would like to use Fawkes to protect your identity, please check out our b
Copyright Copyright
--------- ---------
This code is intended only for personal privacy protection or academic research. 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. We are currently exploring the filing of a provisional patent on the Fawkes algorithm.
@ -39,11 +40,13 @@ when --mode is `custom`:
`fawkes -d ./imgs --mode mid` `fawkes -d ./imgs --mode mid`
### Tips ### Tips
- The perturbation generation takes ~60 seconds per image on a CPU machine, and it would be much faster on a GPU machine. Use `batch-size=1` on CPU and `batch-size>1` on GPUs. - The perturbation generation takes ~60 seconds per image on a CPU machine, and it would be much faster on a GPU machine. Use `batch-size=1` on CPU and `batch-size>1` on GPUs.
- Turn on separate target if the images in the directory belong to different person, otherwise, turn it off. - Turn on separate target if the images in the directory belong to different person, otherwise, turn it off.
- Run on GPU. The current fawkes package and binary does not support GPU. To use GPU, you need to clone this, install the required packages in `setup.py`, and replace tensorflow with tensorflow-gpu. Then you can run fawkes by `python3 fawkes/protection.py [args]`. - Run on GPU. The current fawkes package and binary does not support GPU. To use GPU, you need to clone this, install the required packages in `setup.py`, and replace tensorflow with tensorflow-gpu. Then you can run fawkes by `python3 fawkes/protection.py [args]`.
### How do I know my images are secure? ### How do I know my images are secure?
We are actively working on this. Python script that can test the protection effectiveness will be ready shortly. We are actively working on this. Python script that can test the protection effectiveness will be ready shortly.
Quick Installation Quick Installation
@ -57,9 +60,10 @@ pip install fawkes
If you don't have root privilege, please try to install on user namespace: `pip install --user fawkes`. If you don't have root privilege, please try to install on user namespace: `pip install --user fawkes`.
[pypi_fawkes]: https://pypi.org/project/fawkes/
### Citation ### Citation
``` ```
@inproceedings{shan2020fawkes, @inproceedings{shan2020fawkes,
title={Fawkes: Protecting Personal Privacy against Unauthorized Deep Learning Models}, title={Fawkes: Protecting Personal Privacy against Unauthorized Deep Learning Models},