new model runner content type/accept header
[face-privacy-filter.git] / docs / tutorials / demonstration.rst
1 .. ===============LICENSE_START=======================================================
2 .. Acumos CC-BY-4.0
3 .. ===================================================================================
4 .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 .. ===================================================================================
6 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
7 .. under the Creative Commons Attribution 4.0 International License (the "License");
8 .. you may not use this file except in compliance with the License.
9 .. You may obtain a copy of the License at
10 ..
11 ..      http://creativecommons.org/licenses/by/4.0
12 ..
13 .. This file is distributed on an "AS IS" BASIS,
14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 .. See the License for the specific language governing permissions and
16 .. limitations under the License.
17 .. ===============LICENSE_END=========================================================
18
19 .. _demonstration_face-privacy:
20
21 =========================================
22 Demonstrations: Tutorial for Face Privacy
23 =========================================
24
25 Web Demo
26 ========
27
28 This web page sample allows the user to submit an image to a face
29 detection and a face pixelation service in serial progression.
30
31 * ***Image Copyrights May Apply*** - the included sample videos may
32 carry additional copyright restrictions and are not meant for public resale or
33 consumption.
34
35 Browser Interaction
36 ===================
37
38 Most browsers should have no CORS or other cross-domain objections to
39 dropping the file ``face-privacy.html`` into the browser and accesing a
40 locally hosted server API, as configured in :ref:`deployment_face-privacy`.
41
42
43 Open-source hosted run
44 -----------------------
45
46 Utilizing the generous `htmlpreview function <https://htmlpreview.github.io/>`__
47 available on GitHub, you
48 can also experiment with the respository-based web resource. This
49 resource will proxy the repository ``web_demo`` directory into a live
50 resource.
51
52 Navigate to the
53 `default webhost page <http://htmlpreview.github.io/?https://github.com/acumos/face-privacy-filter/blob/master/web_demo/face-privacy.html>`__
54 and confirm that the resource load properly. The image at the bottom of
55 this guide is a good reference for correct page loading and display.
56
57 After confirming correct page load, simply replace the value in the
58 ``Transform URL`` field to point at your deployed instance. For example,
59 if you've created a dumped model locally, it might be a localhost port.
60
61
62 Local webserver run
63 -------------------
64
65 If you want to run the test locally, you can use a supplied python
66 webserver with the line below while working in the ``web_demo``
67 directory (assuming you're running python3).
68
69 ::
70
71     python simple-cors-http-server-python3.py 5000
72
73 Afterwards, just point your browser at
74 ``http://localhost:5000/face-privacy.html``.
75
76
77 Usage of protobuf binaries for testing
78 --------------------------------------
79 Binary (protobuf encoded) data can be downloaded from the web page or directly with curl.
80 Two demonstration binaries have been included in the source repository for testing.
81
82 - ``protobuf.Image.bin`` - a protobuf-encoded image of Ellen DeGeneres
83 - ``protobuf.RegionDetectionSet.bin`` - a protobuf-encoded region set from the reunion example
84
85 Within the webpage demo, simply select the correct protobuf method and then drag and
86 drop the binary file into the ``Protobuf Payload Input`` file uploader.  It will be
87 immediately uploaded through javascript to your specified ``Transform Url``.
88
89
90 Example face privacy demo (docker and protobuf)
91 ===============================================
92
93 To customize this demo, one should change either the included javascript
94 or simply update the primary classification URL on the page itself
95 during runtime. This demo utilizes the
96 `javascript protobuf library <https://github.com/dcodeIO/ProtoBuf.js/>`__ to encode
97 parameters into proto binaries in the browser.
98
99 ***NOTE*** One version of the face model's protobuf schema is
100 included with this web page, but it may change over time. If you receive
101 encoding errors or unexpected results, please verify that your target
102 model and this web page are using the same ``.proto`` file.
103
104 -  confirm that your target docker instance is configured and running
105 -  download this directory to your local machine
106
107    -  confirm the host port and classification service URL in the file
108       ``face-privacy.js``
109    -  modify the ``protoDefault`` setting to be 1
110
111       ::
112
113           urlDefault: "http://localhost:8884/model/methods/detect",
114
115 -  view the page ``face-privacy.html`` in a Crome or Firefox browser
116 -  you can switch between a few sample images or upload your own by
117    clicking on the buttons below the main image window
118
119 Compatibility
120 -------------
121 If you want to run against the Boreas model runner you must set the URL to end
122 with /model/methods/detect. The key is that in Boreas release the model runner
123 api has changed. You can see the swagger for the model if you visit the source
124 model's swagger.
125
126 If you have a model that was onboarded using Athena release you do not need
127 the /model/methods check. Use /detect instead. Another change that was made
128 in Boreas model runner was that you must send the http headers before the
129 default was protobuf. These headers will change automatically when use use
130 /model/methods/detect as the URL path.
131
132     - Content-type: application/vnd.google.protobuf
133     - Accept: application/vnd.google.protobuf
134
135
136 Special decoding example
137 ------------------------
138
139 In ``protobuf`` mode, you can also download a binary, encoded version of
140 the last image that was sent to the remote service. When available, the
141 Download Encoded Message button will be enabled and a binary file will
142 be generated in the browser.
143
144 ::
145
146     protoc --decode=HipTviKTkIkcmyuMCIAIDkeOOQQYyJne.Image model.pixelate.proto < protobuf.bin
147
148 **NOTE** The specific package name may have changed since the time of
149 writing, so be sure to check the contents of the current ``.proto``
150 file.
151
152 Example face privacy demo (HTTP parameters)
153 -------------------------------------------
154
155 To customize this demo, one should change either the included javascript
156 or simply update the primary classification URL on the page itself
157 during runtime.
158
159 -  confirm that your local instance is configured and running
160 -  download this directory to your local machine
161
162    -  confirm the host port and classification service URL in the file
163       ``face-privacy.js``
164    -  modify the ``protoDefault`` setting to be 0
165
166       ::
167
168           urlDefault: "http://localhost:8884/transform",
169
170 -  view the page ``face-privacy.html`` in a Crome or Firefox browser
171 -  you can switch between a few sample images or upload your own by
172    clicking on the buttons below the main image window
173
174 Example Interface
175 =================
176
177 An instance should first be built and downloaded and then launched
178 locally. Afterwards, the sample application found in the
179 ``web_demo`` directory uses a ``localhost`` service to classify and
180 visualize the results of image classification.
181
182 -  Commercial example (`youtube source <https://www.youtube.com/watch?v=34KfCNapnUg>`__)
183 -  Reunion face sample  `flickr source <https://flic.kr/p/bEgYbs>`__)
184 -  family face example (`pexel source <https://www.pexels.com/photo/adult-affection-beautiful-beauty-265764/>`__)
185 -  DiCaprio celebrity face sample (`wikimedia source <https://en.wikipedia.org/wiki/Celebrity#/media/File:Leonardo_DiCaprio_visited_Goddard_Saturday_to_discuss_Earth_science_with_Piers_Sellers_(26105091624)_cropped.jpg>`__)
186 -  Schwarzenegger celebrity (`wikimedia source <https://upload.wikimedia.org/wikipedia/commons/thumb/0/0f/A._Schwarzenegger.jpg/220px-A._Schwarzenegger.jpg>`__)
187 -  DeGeneres celebrity face sample (`wikipedia source <https://en.wikipedia.org/wiki/Ellen_DeGeneres#/media/File:Ellen_DeGeneres-2009.jpg>`__)
188
189
190 .. image:: example_running.jpg
191     :alt: example web application with blurring activated
192     :width: 200
193
194
195 Reuse with object detectors
196 ---------------------------
197 This framework can be used to demonstrate other detector and manipulation models 
198 as well.  If the detect model included in this repo is used, faces can be detected
199 and illustrated as shown below.  The example below shows use of the
200 relevant endpoint and ``.proto`` file (also included in this sample).
201
202 .. _demonstration-face-privacy_running_example_obj:
203 .. image:: example_running_detect.jpg
204     :alt: example web application detecting faces
205     :width: 200
206