Merge pull request #11 from dlr-eoc/10_support_openvino

added optional support for openvino provider

.github/workflows/pythonapp.yml

@@ -25,7 +25,7 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        pip install coverage
+        pip install coverage onnxruntime
     - name: Test with pytest
       run: |
         pytest

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+[0.1.7] (2022-12-09)
+--------------------
+Added
+*******
+- added support for onnxruntime-openvino provider
+
 [0.1.6] (2022-11-30)
 --------------------
 Changed

README.md

@@ -65,19 +65,25 @@ csmask_valid.write_to_file("sentinel2_valid.tif", dtype="uint8", compress="PACKB
 ````
 
 ## Installation
-The easiest way to install ukis-csmask is through pip. The default installation supports CPU computation.
+The easiest way to install ukis-csmask is through pip. To install ukis-csmask with [default CPU provider](https://onnxruntime.ai/docs/execution-providers/) run the following.
 
 ```shell
-pip install ukis-csmask
+pip install ukis-csmask[cpu]
 ```
 
-To install ukis-csmask with GPU support run the following instead. This requires that you have a GPU with CUDA runtime libraries installed on the system.
+To install ukis-csmask with [OpenVino support](https://onnxruntime.ai/docs/execution-providers/OpenVINO-ExecutionProvider.html) for enhanced CPU inference run the following instead.
+
+```shell
+pip install ukis-csmask[openvino]
+```
+
+To install ukis-csmask with [GPU support](https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html) run the following instead. This requires that you have a GPU with CUDA runtime libraries installed on the system.
 
 ```shell
 pip install ukis-csmask[gpu]
 ```
 
-For a list of dependencies check the [requirements](https://github.com/dlr-eoc/ukis-csmask/blob/main/requirements.txt).
+ukis-csmask depends on [onnxruntime](https://onnxruntime.ai/). For a list of additional dependencies check the [requirements](https://github.com/dlr-eoc/ukis-csmask/blob/main/requirements.txt).
 
 ## Contributors
 The UKIS team creates and adapts libraries which simplify the usage of satellite data. Our team includes (in alphabetical order):

requirements.txt

@@ -1,3 +1,2 @@
 numpy
-onnxruntime>=1.13
 scipy

setup.py

@@ -36,9 +36,15 @@ def get_version(rel_path):
     packages=find_packages(),
     install_requires=open("requirements.txt").read().splitlines(),
     extras_require={
+        "cpu": [
+            "onnxruntime",
+        ],
         "gpu": [
             "onnxruntime-gpu",
         ],
+        "openvino": [
+            "onnxruntime-openvino",
+        ],
         "dev": [
             "pytest",
         ],

ukis_csmask/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.6"
+__version__ = "0.1.7"

ukis_csmask/mask.py

@@ -1,11 +1,20 @@
-from pathlib import Path
-
 import numpy as np
-import onnxruntime
+
+from pathlib import Path
 from scipy import ndimage
 
 from .utils import reclassify, tile_array, untile_array
 
+try:
+    import onnxruntime
+except ImportError as e:
+    msg = (
+        "ukis-csmask dependencies are not installed.\n\n"
+        "Please pip install as follows and specify your desired runtime provider [cpu], [openvino] or [gpu]:\n\n"
+        "  python -m pip install ukis-csmask[cpu] --upgrade"
+    )
+    raise ImportError(str(e) + "\n\n" + msg)
+
 
 class CSmask:
     """Segments clouds and cloud shadows in multi-spectral satellite images."""