documentation (go to RST), prune deprecation
[face-privacy-filter.git] / docs / release-notes.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 .. _release_notes_face-privacy:
20
21 =================================
22 Face Privacy Filter Release Notes
23 =================================
24
25 0.3.4
26 =====
27
28 -  Clean up tutorial documentation naming and remove deprecated swagger demo app
29
30 0.3.3
31 =====
32
33 -  Clean up documentation for install and parameter descriptions
34 -  Add documentation and functionality for environment variables in push
35    request
36
37 0.3.2
38 =====
39
40 -  Minor updates to web JS demo pages for pending recognition model
41 -  *Type Change* rename input and output types to **region** monikers to
42    better reflect target
43
44 0.3.1
45 =====
46
47 -  Update model to use single image as input type
48 -  Update javascript demo to run with better CORS behavior (github
49    htmlpreview)
50 -  Additional documentation for environmental variables
51 -  Simplify operation for active prediction to use created model (no
52    save+load required)
53
54 0.3.0
55 =====
56
57 -  Documentation (lesson1) updated with model runner examples.
58    Deprecation notice in using explicit proto- and swagger-based serves.
59 -  Update the structure of the protobuf input and output to use
60    flattened (row-based) structure instead of columnar data for all i/o
61    channels. This should allow other inspecting applications to more
62    easily understand and reuse implementations for image data.
63 -  Update the demonstration HTML pages for similar modifications.
64
65 0.2.3
66 =====
67
68 -  Documentation and package update to use install instructions instead
69    of installing this package directly into a user's environment.
70 -  License addition
71
72 0.2.2
73 =====
74
75 -  Refactor documentation into sections and tutorials.
76 -  Create this release notes document for better version understanding.
77
78 0.2.1
79 =====
80
81 -  Refactor to remote the demo ``bin`` scripts and rewire for direct
82    call of the script ``filter_image.py`` as the primary interaction
83    mechanism.
84
85 0.2.0
86 =====
87
88 -  Refactor for compliant dataframe usage following primary client
89    library examples for repeated columns (e.g. dataframes) instead of
90    custom types that parsed rows individually.
91 -  Refactor web, api, main model wrapper code for corresponding changes.
92 -  Migration from previous library structure to new acumos client
93    library
94 -  Refactor to not need **this** library as a runtime/installed
95    dependency