revise doc text to have good catalog text primer
[face-privacy-filter.git] / docs / face-privacy-filter.md
1 <!---
2 .. ===============LICENSE_START=======================================================
3 .. Acumos CC-BY-4.0
4 .. ===================================================================================
5 .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
6 .. ===================================================================================
7 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
8 .. under the Creative Commons Attribution 4.0 International License (the "License");
9 .. you may not use this file except in compliance with the License.
10 .. You may obtain a copy of the License at
11 ..
12 ..      http://creativecommons.org/licenses/by/4.0
13 ..
14 .. This file is distributed on an "AS IS" BASIS,
15 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 .. See the License for the specific language governing permissions and
17 .. limitations under the License.
18 .. ===============LICENSE_END=========================================================
19 -->
20
21 # Face Privacy Filter Guide
22 This model contains the capability to generate two submodels:
23 one for face detection and oen for face suppression through pixelation.
24
25 # Face Detection Model Guide
26 A model example for face detection from images within Acumos.
27
28 ## Background
29 This model analyzes static images to detect frontal faces.  It utilizes a
30 frontal face cascade from the
31 [OpenCV](https://opencv.org/) image processing library.
32 Model load time is optimized by creating and maintaining the fixed cascade
33 in memory while operating.  Demonstrating the capability of custom classes
34 and requisite member variables, the cascade is serialized with the model as
35 a string asset which is deserialized and loaded from disk upon startup.
36
37 ## Usage
38 Input to the model is an array of one or more tuples of image binary data
39 and a binary mime type.  The position of the image within the array is utilized
40 in the output signature as a zero-based index.  For example if three images
41 were sent, the output probabilities would have 0, 1, and 2 as index values.
42 The output from this model is a repeated array of detected regions for each
43 face in each input image.  So that image data can be cascaded to other models,
44 the original image and mime type are also embedded with the special
45 region code `-1` within the output.
46
47 A web demo is included with the source code, available via the
48 [Acumos Gerrit repository](https://gerrit.acumos.org/r/gitweb?p=face-privacy-filter.git;a=summary).
49 It utilizes a protobuf javascript library and processes
50 input images to detect all faces within an image.
51
52 ## Performance
53 As this model wraps a preexisting cascade, no formal testing evaluation
54 was performed.  However, experimental usage indicates the following highlights.
55
56 * Faces that are too small can easily be missed.
57 * Frontal faces perform best, with some tolerance of about 5-10 degrees off-plane rotation.
58 * Detection is fairly sensitive to rotation in plane, so try not to let subject faces rotate more than 15 degrees.
59 * Dark or low contrast images generally do not perform well for detection.
60
61 ## More Information
62 As this model uses a generic cascade from OpenCV, readers can easily
63 substituted or update those models with no change in API endpoint required.
64 Additionally, secondary verification methods using pixel validation (e.g.
65 sub-part verification, symmetry tests, or more advanced parts-based
66 verifications) may dramatically improve the false alarm rate, although
67 the current model was tuned for precision (instead of recall) already.
68
69
70
71 # Face Pixelation Model Guide
72 A model example to anonymize faces from images via pixelation within Acumos.
73
74 ## Background
75 This model accepts detected faces and their source image and produces
76 pixelated image results.  It utilizes simple image manipulation methods
77 from the [OpenCV](https://opencv.org/) image processing library.
78 This model is a demonstration of a
79 transform operation: there is neither state nor static model data
80 utilized and all data comes from the upstream input.
81
82
83 ## Usage
84 Input to the model is an array of one or more tuples of detected face regions
85 as well as the original image binary data and a binary mime type.  The row or
86 sample containing the original image is specially marked by a region code
87 of ‘-1’.  The output from this model is an array of images (one for each
88 unique image input) with the detected face regions blurred via pixelation.
89
90 A web demo is included with the source code, available via the
91 [Acumos Gerrit repository](https://gerrit.acumos.org/r/gitweb?p=face-privacy-filter.git;a=summary).
92 It utilizes a protobuf javascript library and processes
93 input images to detect all faces within an image.
94
95 ## Performance
96 As this model is a data transform example that flattens detected image regions into images.
97
98 * Faces not included in the detected regions are ignored.
99 * Faces whose images do not exist in the input (e.g. region and image indices
100   are provided, but no original image) are ignored.
101 * The mime type for the output image is constructed to mimic the input image and mime type.
102
103 ## More Information
104 This model uses processing methods from OpenCV, so any number of additional
105 privacy methods could be employed, like blurring, substitution, etc. More
106 advanced techniques that still allow some information processing (e.g.
107 demographics but not recognition) may also be easily employed with this
108 system, should the right method arise.
109
110
111
112 # Source Installation
113 This section is useful for source-based installations and is not generally intended
114 for catalog documentation.
115
116 ## Image Analysis for Face-based Privacy Filtering
117 This source code creates and pushes a model into Acumos that processes
118 incoming images and outputs a detected faces as well as the original image
119 input (if configured that way).  The model uses a [python interface](https://pypi.python.org/pypi/opencv-python)
120 to the [OpenCV library](https://opencv.org/) to detect faces and perform
121 subsequent image processing.  This module does not support training
122 at this time and instead uses a pre-trained face cascade, which is
123 included (from OpenCV) in this module.
124
125 ### Package dependencies
126 Package dependencies for the core code and testing have been flattened into a
127 single file for convenience. Instead of installing this package into your
128 your local environment, execute the command below.
129
130 ```
131 pip install -r requirments.txt
132 ```
133
134 **Note:** If you are using an [anaconda-based environment](https://anaconda.org),
135 you may want to try
136 installing these packages [directly](https://docs.anaconda.com/anaconda-repository/user-guide/tasks/pkgs/download-install-pkg).
137 to avoid mixing of `pip` and `conda` package stores.
138
139 ### Usage
140 This package contains runable scripts for command-line evaluation,
141 packaging of a model (both dump and posting), and simple web-test
142 uses.   All functionality is encapsulsted in the `filter_image.py`
143 script and has the following arguments.
144
145 ```
146 usage: filter_image.py [-h] [-p PREDICT_PATH] [-i INPUT]
147                        [-c] [-s] [-f {detect,pixelate}]
148                        [-a PUSH_ADDRESS] [-d DUMP_MODEL]
149
150 optional arguments:
151   -h, --help            show this help message and exit
152   -p PREDICT_PATH, --predict_path PREDICT_PATH
153                         save detections from model (model must be provided via
154                         'dump_model')
155   -i INPUT, --input INPUT
156                         absolute path to input data (image or csv, only during
157                         prediction / dump)
158   -c, --csv_input       input as CSV format not an image
159   -s, --suppress_image  do not create an extra row for a returned image
160   -f {detect,pixelate}, --function {detect,pixelate}
161                         which type of model to generate
162   -a PUSH_ADDRESS, --push_address PUSH_ADDRESS
163                         server address to push the model (e.g.
164                         http://localhost:8887/v2/models)
165   -d DUMP_MODEL, --dump_model DUMP_MODEL
166                         dump model to a pickle directory for local running
167 ```
168
169
170
171 # Example Usages
172 Please consult the [tutorials](tutorials) dirctory for usage examples
173 including an in-place [web page demonstration](tutorials/lesson3.md).
174
175 ## Face-based Use Cases
176 This project includes a number of face-based use cases including raw
177 detection, blurring, and other image-based modifications based on
178 detected image regions.
179
180 * **Face Detection Use-case** - This source code creates and pushes a model that processes
181 incoming images and outputs detected faces.
182
183 # Release Notes
184 The [release notes](release-notes.md) catalog additions and modifications
185 over various version changes.
186
187 # Metadata Examples
188 * [example detect catalog image](catalog_image_detect.png) - [url source](https://flic.kr/p/xqw25C)
189 * [example blur catalog image](catalog_image_blur.png)  - [url source](https://flic.kr/p/bEgYbs)