testing/README.md

   1 # web_test
   2 This directory provides a simple web server for demonstrating a face-privacy filter example.
   3 This web demo will launch an application with a swagger page.
   4
   5 ## Example usage
   6
   7 ```
   8 $ python app.py
   9 usage: app.py [-h] [--port PORT] [--modeldir MODELDIR] [--rich_return]
  10
  11 optional arguments:
  12   -h, --help           show this help message and exit
  13   --port PORT          port to launch the simple web server
  14   --modeldir MODELDIR  model directory to load dumped artifact
  15 ```
  16
  17 ### Output formats
  18 The optional HTTP parameter `rich_output` will generate a more decorated JSON output
  19  that is also understood by the included web application.
  20
  21 * standard output - from `DataFrame` version of the transform
  22 ```
  23
  24
  25 ```
  26
  27
  28 * rich output - formatted form of the transform
  29 ```
  30 ```
  31
  32 ## Face Privacy Filtering
  33
  34 * For a graphical experience, view the swagger-generated UI at [http://localhost:8884/ui].
  35 * Additionally, a simple command-line utility could be used to post an image
  36 and mime type to the main interface.
  37 ```
  38 curl -F image_binary=@test.jpg -F rich_output="true" -F mime_type="image/jpeg" "http://localhost:8884/transform"
  39 ```