Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pypi link to README #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add pypi link to README #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ If you would like to use Fawkes to protect your identity, please check out our b

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.
Expand Down Expand Up @@ -39,11 +40,13 @@ when --mode is `custom`:
`fawkes -d ./imgs --mode mid`

### 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.
- 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]`.

### 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.

Quick Installation
Expand All @@ -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`.


[pypi_fawkes]: https://pypi.org/project/fawkes/

### Citation

```
@inproceedings{shan2020fawkes,
title={Fawkes: Protecting Personal Privacy against Unauthorized Deep Learning Models},
Expand Down