cc6de376f0b98278f6ffaf6f3906d16b5e2e6f6a
[face-privacy-filter.git] / docs / tutorials / lesson3.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 # Web Demo
22 This web page sample allows the user to submit an image to
23 an image classification and image mood classification service
24 in serial progression.
25
26 ** Image Copyrights May Apply ** - the included sample videos may carry
27 additional copyrights and are not meant for public resale or consumption.
28
29 ## Browser Interaction
30 Most browsers should have no
31 CORS or other cross-domain objections to dropping the file `face-privacy.html`
32 into the browser and accesing a locally hosted server API, as configured
33 in [the previous tutorial](lesson2.md).
34
35 If you want to run the test locally, you can use the built-in python
36 webserver with the line below while working in the `web_demo` directory
37 (assuming you're running python3).
38 ```
39 python -m http.server 5000
40 ```
41
42 Afterwards, just point your browser at `http://localhost:5000/face-privacy.html`.
43
44 ## Example mood classification demo (docker and protobuf)
45 To customize this demo, one should change either the included javascript
46 or simply update the primary classification URL on the page itself during runtime.
47 This demo utilizes the [javascript protobuf library](https://github.com/dcodeIO/ProtoBuf.js/)
48 to encode parameters into proto binaries in the browser.
49
50 ** NOTE ** One version of the face model's protobuf schema is included with
51 this web page, but it may change over time.  If you receive encoding errors
52 or unexpected results, please verify that your target model and this web page
53 are using the same `.proto` file.
54
55 * confirm that your target docker instance is configured and running
56 * download this directory to your local machine
57     * confirm the host port and classification service URL in the file `face-privacy.js`
58     * modify the `protoDefault` setting to be 1
59 ```
60 urlDefault: "http://localhost:8884/transform",
61 ```
62 * view the page `face-privacy.html` in a Crome or Firefox browser
63 * you can switch between a few sample images or upload your own by clicking on the buttons below the main image window
64
65 Example web application with blur process.
66
67 * ![example web application blurring multiple faces](example_running.jpg "Example multi-face blur")
68
69 ### Special decoding example
70 In `protobuf` mode, you can also download a binary, encoded version of the last
71 image that was sent to the remote service.  When available, the <strong>Download Encoded Message</strong>
72 button will be enabled and a binary file will be generated in the browser.
73
74 ```
75 protoc --decode=sapLzHrujUMPBGCBEMWQFxEIMsxocFrG.FaceImage model.pixelate.proto < protobuf.bin
76 ```
77
78 **NOTE** The specific package name may have changed since the time of writing,
79 so be sure to check the contents of the current `.proto` file.
80
81
82 ## Example mood classification demo (HTTP parameters)
83 To customize this demo, one should change either the included javascript
84 or simply update the primary classification URL on the page itself during runtime.
85
86 * confirm that your local instance is configured and running
87 * download this directory to your local machine
88     * confirm the host port and classification service URL in the file `face-privacy.js`
89     * modify the `protoDefault` setting to be 0
90 ```
91 urlDefault: "http://localhost:8884/transform",
92 ```
93 * view the page `face-privacy.html` in a Crome or Firefox browser
94 * you can switch between a few sample images or upload your own by clicking on the buttons below the main image window
95
96
97 # Example Interface
98 An instance should first be built and downloaded and then
99 launched locally.  Afterwards, the sample application found in
100 [web_demo](web_demo) uses a `localhost` service to classify
101 and visualize the results of image classification.
102
103 * [Commercial example](../../web_demo/images/commercial.jpg) ([youtube source](https://www.youtube.com/watch?v=34KfCNapnUg))
104 * [Reunion face sample](../../web_demo/images/face_reunion.jpg) ([flickr source](https://flic.kr/p/bEgYbs))
105 * [family face example](../../web_demo/images/face_family.jpg) ([pexel source](https://www.pexels.com/photo/adult-affection-beautiful-beauty-265764/))
106 * [DiCaprio celebrity face sample](../../web_demo/images/face_DiCaprio.jpg) ([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))
107 * [Schwarzenegger celebrity face sample](../../web_demo/images/face_Schwarzenegger.jpg) ([wikimedia source](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0f/A._Schwarzenegger.jpg/220px-A._Schwarzenegger.jpg))
108
109
110 before  | after
111 ------- | -------
112 ![raw commercial](../../web_demo/images/commercial.jpg)  | ![pixelated commercial](../../web_demo/images/commercial_pixelate.jpg)
113 ![raw face](../../web_demo/images/face_family.jpg)  | ![pixelated commercial](../../web_demo/images/face_family_pixelate.jpg)