Merge pull request #15 from Senzing/ot_add_version_1_1_0

Add information about version 1.1.0

CHANGELOG.md

@@ -7,6 +7,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.1.0] - 2023-12-20
+
+### Added to 1.1.0
+
+- Data about and links to version 1.1.0 of Senzing data model
+- Statsitcs about parsing improvements
+
 ## [1.0.0] - 2023-02-13
 
 ### Added to 1.0.0

README.md

@@ -8,6 +8,41 @@ Senzing has been working on updates of the libpostal data model for some time. T
 We have included regular updates to the model in our [Senzing API](https://senzing.com/senzing-api/) product.
 We are now making our data models available to broader audience.
 
+## Version 1.1.0
+This version is composed of 3 files
+- language_classifier.tar.gz - This is the same file default libpostal data model has.
+- libpostal_data.tar.gz - This file is also the same as used by default libpostal datamodel.
+- parser.tar.gz - This is the new updated parser model.
+
+To download click on the links below and the browser with download them for you:
+- https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/language_classifier.tar.gz
+- https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/libpostal_data.tar.gz
+- https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/parser.tar.gz
+
+or you can use curl
+```
+curl https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/language_classifier.tar.gz -o language_classifier.tar.gz
+curl https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/libpostal_data.tar.gz -o libpostal_data.tar.gz
+curl https://public-read-libpostal-data.s3.amazonaws.com/v1.1.0/parser.tar.gz -o parser.tar.gz
+```
+
+To install extract the file in the libpostal data directory:
+```
+tar -zxvf ../language_classifier.tar.gz
+tar -zxvf ../libpostal_data.tar.gz
+tar -zxvf ../parser.tar.gz
+```
+
+### Changes and improvements from version 1.0.0
+- Latest data from all sources
+- Improved parses for Japanese addresses
+- Improved handling of Mexican state codes
+
+### Quality
+We have made some modification to our test data set to improve variations of address and test for improvements we made in this version.  It now has 12951 addresses from 89 countries.
+The over all parsing accuracy improved by 1.09%.  We had improved statistics for 33 countries and had regression with 10.
+You can find statistical comparison of the tests [here](./files/stats/v1.1.0/Parsing_comparison_v1_0_0.md).
+
 ## Version 1.0.0
 This version is composed of 3 files 
 - language_classifier.tar.gz - This is the same file default libpostal data model has.

files/stats/v1.1.0/Parsing_comparison_v1_1_0.md

@@ -0,0 +1,90 @@
+|Country|% improvement|Total records|Failures - v1.0.0|Percent failed - v1.0.0|Failures - v1.1.0|Percent_failed - v1.1.0|
+|---|---|---|---|---|---|---|
+|ae|0.00|50|10|20|10|20|
+|am|0.00|50|3|6|3|6|
+|ar|2.67|75|15|20|13|17.33|
+|at|0.00|229|17|7.42|17|7.42|
+|au|10.53|76|8|10.53|0|0|
+|az|0.00|50|7|14|7|14|
+|ba|0.00|50|11|22|11|22|
+|bd|0.00|50|43|86|43|86|
+|be|0.00|121|21|17.36|21|17.36|
+|bg|0.00|50|25|50|25|50|
+|br|0.00|51|3|5.88|3|5.88|
+|by|-26.00|50|14|28|27|54|
+|ca|0.46|432|46|10.65|44|10.19|
+|ch|0.00|135|18|13.33|18|13.33|
+|cl|2.00|50|35|70|34|68|
+|cn|-1.14|88|47|53.41|48|54.55|
+|co|0.00|57|14|24.56|14|24.56|
+|cy|-4.00|50|38|76|40|80|
+|cz|0.00|50|1|2|1|2|
+|de|0.00|2019|563|27.89|563|27.89|
+|dk|0.00|303|0|0|0|0|
+|ec|2.00|50|13|26|12|24|
+|ee|1.92|52|1|1.92|0|0|
+|eg|6.00|50|9|18|6|12|
+|es|-1.15|87|18|20.69|19|21.84|
+|fi|0.00|52|10|19.23|10|19.23|
+|fo|0.00|50|0|0|0|0|
+|fr|0.00|135|2|1.48|2|1.48|
+|gb|0.00|255|52|20.39|52|20.39|
+|ge|0.00|50|27|54|27|54|
+|gr|0.00|50|3|6|3|6|
+|gt|2.00|50|27|54|26|52|
+|hr|2.00|50|4|8|3|6|
+|hu|0.99|101|5|4.95|4|3.96|
+|id|-2.00|50|30|60|31|62|
+|ie|-2.00|50|26|52|27|54|
+|il|1.97|51|7|13.73|6|11.76|
+|im|-12.00|50|28|56|34|68|
+|in|6.00|50|33|66|30|60|
+|is|0.00|50|6|12|6|12|
+|it|0.00|342|26|7.6|26|7.6|
+|jm|8.00|50|34|68|30|60|
+|jp|16.00|50|40|80|32|64|
+|kg|2.00|50|4|8|3|6|
+|kr|3.92|51|36|70.59|34|66.67|
+|kw|0.00|50|0|0|0|0|
+|kz|3.45|58|2|3.45|0|0|
+|li|0.00|51|4|7.84|4|7.84|
+|lt|0.00|126|4|3.17|4|3.17|
+|lu|0.00|50|6|12|6|12|
+|lv|0.00|50|26|52|26|52|
+|md|8.00|50|4|8|0|0|
+|mk|0.00|50|8|16|8|16|
+|mx|3.51|57|19|33.33|17|29.82|
+|my|11.11|54|28|51.85|22|40.74|
+|nc|33.34|51|20|39.22|3|5.88|
+|nl|0.00|1151|2|0.17|2|0.17|
+|no|0.00|287|0|0|0|0|
+|nz|1.96|51|2|3.92|1|1.96|
+|pe|0.00|50|6|12|6|12|
+|ph|-2.00|50|11|22|12|24|
+|pk|2.00|50|38|76|37|74|
+|pl|0.32|628|44|7.01|42|6.69|
+|pr|-4.00|50|37|74|39|78|
+|pt|4.00|50|5|10|3|6|
+|re|42.00|50|24|48|3|6|
+|ro|0.00|51|1|1.96|1|1.96|
+|rs|0.00|50|2|4|2|4|
+|ru|0.57|525|14|2.67|11|2.1|
+|se|1.61|62|4|6.45|3|4.84|
+|sg|-1.85|54|1|1.85|2|3.7|
+|si|2.00|50|2|4|1|2|
+|sk|0.00|50|10|20|10|20|
+|sm|0.00|50|0|0|0|0|
+|sr|0.00|50|0|0|0|0|
+|tj|0.00|50|17|34|17|34|
+|tr|0.00|50|32|64|32|64|
+|tt|0.00|50|2|4|2|4|
+|tw|0.00|177|53|29.94|53|29.94|
+|tz|0.00|50|48|96|48|96|
+|ua|-1.85|54|6|11.11|7|12.96|
+|us|2.92|2263|177|7.82|111|4.9|
+|uy|1.13|88|2|2.27|1|1.14|
+|uz|0.00|50|5|10|5|10|
+|vn|2.00|50|29|58|28|56|
+|xk|0.00|50|48|96|48|96|
+|za|1.96|51|18|35.29|17|33.33|
+|total|1.09|12951|2141|16.53|1999|15.44|