- add auth arg
[face-privacy-filter.git] / docs / face-privacy-filter.md
1 # face-privacy-filter
2 A model for face detection and suppression.
3
4 ## Image Analysis for Face-based Privacy Filtering
5 This source code creates and pushes a model into Acumos that processes
6 incoming images and outputs a detected faces as well as the original image
7 input (if configured that way).  The model uses a [python interface](https://pypi.python.org/pypi/opencv-python)
8 to the [OpenCV library](https://opencv.org/) to detect faces and perform
9 subsequent image processing.  This module does not support training
10 at this time and instead uses a pre-trained face cascade, which is
11 included (from OpenCV) in this module.
12
13 ### Usage
14 This package contains runable scripts for command-line evaluation,
15 packaging of a model (both dump and posting), and simple web-test
16 uses.   All functionality is encapsulsted in the `filter_image.py`
17 script and has the following arguments.
18
19 ```
20 usage: filter_image.py [-h] [-p PREDICT_PATH] [-i INPUT]
21                        [-c] [-s] [-f {detect,pixelate}]
22                        [-a PUSH_ADDRESS] [-d DUMP_MODEL]
23
24 optional arguments:
25   -h, --help            show this help message and exit
26   -p PREDICT_PATH, --predict_path PREDICT_PATH
27                         save detections from model (model must be provided via
28                         'dump_model')
29   -i INPUT, --input INPUT
30                         absolute path to input data (image or csv, only during
31                         prediction / dump)
32   -c, --csv_input       input as CSV format not an image
33   -s, --suppress_image  do not create an extra row for a returned image
34   -f {detect,pixelate}, --function {detect,pixelate}
35                         which type of model to generate
36   -a PUSH_ADDRESS, --push_address PUSH_ADDRESS
37                         server address to push the model (e.g.
38                         http://localhost:8887/v2/models)
39   -d DUMP_MODEL, --dump_model DUMP_MODEL
40                         dump model to a pickle directory for local running
41 ```
42
43
44
45 # Example Usages
46 Please consult the [tutorials](tutorials) dirctory for usage examples
47 including an in-place [web page demonstration](tutorials/lesson3.md).
48
49 ## Face-based Use Cases
50 This project includes a number of face-based use cases including raw
51 detection, blurring, and other image-based modifications based on
52 detected image regions.
53
54 * **Face Detection Use-case** - This source code creates and pushes a model that processes
55 incoming images and outputs detected faces.
56
57 # Release Notes
58 The [release notes](release-notes.md) catalog additions and modifications
59 over various version changes.
60