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