merge dev for release 0.9.6

.github/CONTRIBUTING.md

@@ -99,7 +99,11 @@ If your pull request introduces a new feature, please deliver it with tests that
 For any pull request submitted, **ALL** of the tests must succeed. You can run the tests with
 
 ``` shell
-python -m unittest
+pytest
+
+# or with multiple CPU
+
+pytest -n 4
 ```
 
 > The integration tests need to be executed on a device with a GPU.

.github/dependabot.yml

@@ -4,12 +4,18 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+    target-branch: "develop"
+    labels:
+      - "Github actions dependencies"
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "monthly"
     open-pull-requests-limit: 10
+    target-branch: "develop"
+    labels:
+      - "pip dependencies"
     allow:
       - dependency-type: direct
       - dependency-type: indirect

.github/workflows/deploy.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: Install dependencies
         run: |
           pip install -Ur requirements.txt

.github/workflows/docker.yml

@@ -6,8 +6,8 @@ on:
   release:
     types: [ created ]
   schedule:
-    # Run the tests at 00:00 each week on sunday
-    - cron: "0 0 * * 0"
+    # Run the tests at 00:00 the first day of each month
+    - cron: "0 0 1 * *"
 
 jobs:
   build:

.github/workflows/docs.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/formatting.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/linting.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/python-publish.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/tests.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
 
     steps:
       - uses: actions/checkout@v3
@@ -28,7 +28,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9" ] # pip install requirements fail on 3.10
+        python-version: [ "3.8", "3.9" ] # pip install requirements fail on 3.10 and 3.11 because of Fasttext
 
     steps:
       - uses: actions/checkout@v3

.pylintrc

@@ -53,7 +53,7 @@ persistent=yes
 
 # Minimum Python version to use for version dependent checks. Will default to
 # the version used to run pylint.
-py-version=3.7
+py-version=3.8
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
@@ -573,5 +573,5 @@ valid-metaclass-classmethod-first-arg=cls
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception

CHANGELOG.md

@@ -273,26 +273,44 @@
 
 ## 0.9.2
 
-- Improve Deepparse server error handling and error output
+- Improve Deepparse server error handling and error output.
 - Remove deprecated argument `saving_dir` in `download_fasttext_magnitude_embeddings`
-  and `download_fasttext_embeddings` functions
-- Add offline argument to remove verification of the latest version
-- Bug-fix cache handling in download model
-- Add `download_models` CLI function
-- [Temporary hot-fix BPEmb SSL certificate error](https://github.com/GRAAL-Research/deepparse/issues/156)
+  and `download_fasttext_embeddings` functions.
+- Add offline argument to remove verification of the latest version.
+- Bug-fix cache handling in download model.
+- Add `download_models` CLI function.
+- [Temporary hot-fix BPEmb SSL certificate error](https://github.com/GRAAL-Research/deepparse/issues/156).
 
 ## 0.9.3
 
- - Improve error handling.
- - Bug-fix FastText error not handled in test API.
- - Add feature to allow new_prediction_tags to retrain CLI.
+- Improve error handling.
+- Bug-fix FastText error not handled in test API.
+- Add feature to allow new_prediction_tags to retrain CLI.
 
 ## 0.9.4
 
-  - Improve codebase.
+- Improve codebase.
 
 ## 0.9.5
 
-  - Fixed tags converter bug with data processor.
+- Fixed tags converter bug with data processor.
+
+## 0.9.6
+
+- Add Python 3.11.
+- Add pre-processor when parsing addresses.
+- Add `pin_memory=True` when using a CUDA device to increase performance as suggested
+  by [Torch documentation](https://pytorch.org/tutorials/recipes/recipes/tuning_guide.html).
+- Add `torch.no_grad()` context manager in `__call__()` to increase performance.
+- Reduce memory swap between CPU and GPU by instantiating Tensor directly on the GPU device.
+- Improve some Warnings clarity (i.e. category and message).
+- Bug-fix MacOS multiprocessing. It was impossible to use in multiprocess since we were not testing whether torch
+  multiprocess was set properly. Now, we set it properly and raise a warning instead of an error.
+- Drop Python 3.7 support since newer Python versions are faster
+  and [Torch 2.0 does not support Python 3.7](https://dev-discuss.pytorch.org/t/dropping-support-for-cuda-11-6-and-python-3-7-from-pytorch-2-0-release/1021).
+- Improve error handling with wrong checkpoint loading in AddressParser retrain_path use.
+- Add `torch.compile` integration to improve performance (Torch 1.x still supported) with `mode="reduce-overhead"` as
+  suggested in the [documentation](https://pytorch.org/tutorials//intermediate/torch_compile_tutorial.html). It
+  increases the performance by about 1/100.
 
 ## dev

README.md

@@ -40,7 +40,7 @@ Use deepparse to
 
 Read the documentation at [deepparse.org](https://deepparse.org).
 
-Deepparse is compatible with the __latest version of PyTorch__ and  __Python >= 3.7__.
+Deepparse is compatible with the __latest version of PyTorch__ and  __Python >= 3.8__.
 
 ### Countries and Results
 

codecov_push.sh

@@ -1,10 +1,12 @@
 #!/bin/sh
+# To run using ZSH: zsh -i ./codecov_push.sh
+# To run using bash: bash -i ./codecov_push.sh
 
-# We do test on Python 3.10
+# We do test on Python 3.11 (latest Python version)
 
 # Create a new Python env for Deepparse tests and activate it
-conda create --name deepparse_pytest_3_10 python=3.10 -y --force
-conda activate deepparse_pytest_3_10
+conda create --name deepparse_pytest_3_11 python=3.11 -y --force
+conda activate deepparse_pytest_3_11
 
 # Install dependencies
 pip install -Ur tests/requirements.txt
@@ -13,12 +15,12 @@ pip install -Ur requirements.txt
 # Run pytest from conda env
 echo "*****Running test in Conda*****"
 # --live-stream is to remove the Conda capture of the stream
-conda run -n deepparse_pytest_3_10 --live-stream pytest --cov ./deepparse --cov-report html --cov-report xml --cov-config=.coveragerc
+conda run -n deepparse_pytest_3_11 --live-stream pytest --cov ./deepparse --cov-report html --cov-report xml --cov-config=.coveragerc
 
 # Push the coverage file
 ./codecov -f coverage.xml -n unittest-integrationtest -t $CODECOVKEYDEEPPARSE
 
 # close conda env
 conda deactivate
 
-conda env remove -n deepparse_pytest_3_10
+conda env remove -n deepparse_pytest_3_11

deepparse/comparer/formatted_compared_addresses.py

@@ -1,3 +1,5 @@
+# pylint: disable=superfluous-parens
+
 import os
 import sys
 from abc import ABC, abstractmethod
@@ -113,7 +115,7 @@ class because they don't use the probabilities the same way.
         """
 
     @staticmethod
-    def _get_color_diff(string_one: str, string_two: str, highlight=False) -> str:
+    def _get_color_diff(string_one: str, string_two: str, highlight: bool = False) -> str:
         """
         Compare two strings and determine the difference between the two. The differences are noted with colour code;
         if the first string has more elements than the second one, it will be noted in one colour; on the contrary,
@@ -171,7 +173,7 @@ def _get_tags_diff_color(
         self,
         name_one: str = "first address",
         name_two: str = "second address",
-        verbose=True,
+        verbose: bool = True,
     ) -> str:
         """
         Print the output of the string with colour codes that represent the differences between the two strings.