[doc] added section about local build on macos in README.md, updated docs, updated changelog

README.md

@@ -113,6 +113,33 @@ URL=http://localhost:7860/infer_samgis
 curl -d@./events/payload_point_eolie.json -H 'content-type: application/json' ${URL}
 ```
 
+#### Local execution on MacOS
+
+There is a known issue running the project on MacOS. SamGIS still work also without executing it within a docker container, but is slower during image embedding because of a memory leak caused by CoreML. Here a log about this bug:
+
+```less
+[...]
+2024-05-15T18:38:37.478698+0200 - INFO - predictors.py - samexporter_predict - (be2506dc-0887-4752-9889-cf12db7501f5) missing instance model mobile_sam, instantiating it now! 
+2024-05-15T18:38:37.479582+0200 - INFO - sam_onnx2.py - __init__ - (be2506dc-0887-4752-9889-cf12db7501f5) Available providers for ONNXRuntime: %s 
+2024-05-15 18:38:37.673229 [W:onnxruntime:, coreml_execution_provider.cc:81 GetCapability] CoreMLExecutionProvider::GetCapability, number of partitions supported by CoreML: 104 number of nodes in the graph: 566 number of nodes supported by CoreML: 383
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+2024-05-15T18:38:47.691608+0200 - INFO - sam_onnx2.py - __init__ - (be2506dc-0887-4752-9889-cf12db7501f5) encoder_input_name: 
+2024-05-15 18:38:47.913677 [W:onnxruntime:, coreml_execution_provider.cc:81 GetCapability] CoreMLExecutionProvider::GetCapability, number of partitions supported by CoreML: 48 number of nodes in the graph: 496 number of nodes supported by CoreML: 221
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+Context leak detected, CoreAnalytics returned false
+2024-05-15T18:38:50.926801+0200 - DEBUG - predictors.py - samexporter_predict - (be2506dc-0887-4752-9889-cf12db7501f5) using a mobile_sam instance model... 
+[...]
+```
+
+This problem doesn't rise if running it within the docker container.
+
 ### Tests
 
 Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests.
@@ -130,7 +157,8 @@ Run the command from the project root:
 
 ```bash
 # missing docs folder (run from project root) initialize this way
-cd docs && sphinx-quickstart -p SamGIS -r 1.0.0 -l python --master index
+# 
+cd docs && sphinx-quickstart --project SamGIS --release 1.0.0 --language python --master index
 
 # update docs folder (from project root)
 sphinx-apidoc -f -o docs samgis

docs/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 1.5.1
+
+- samgis_core: now support onnxruntime 1.17.x and later
+- samgis_core: remove opencv-python dependency, now SegmentAnythingONNX2 resize images using PIL
+- samgis_core: bump to version 2.0.0 to remark a breaking change: passage from SegmentAnythingONNX to SegmentAnythingONNX2
+- known issue: on MacOS, samgis still work without executing it within a docker container, but it's slower during image embedding because of a memory leak caused by CoreML
+
 ## Version 1.5.0
 
 - now it's possible to download tmp images from /vis_output routes if WRITE_TMP_ON_DISK env variable exists (it's the output folder path)

docs/conf.py

@@ -7,16 +7,27 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 import os
 import sys
+import tomllib
+
 
 project = 'SamGIS'
-copyright = '2023-now, alessandro trinca tornidor'
-author = 'alessandro trinca tornidor'
-release = '1.3.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 sys.path.insert(0, os.path.abspath('..'))
 
+# Pull general sphinx project info from pyproject.toml
+# Modified from https://stackoverflow.com/a/75396624/1304076
+with open("../pyproject.toml", "rb") as f:
+    toml = tomllib.load(f)
+
+pyproject = toml["tool"]["poetry"]
+version = pyproject["version"]
+release = version
+authors_list = [author for author in pyproject["authors"]]
+author = ", ".join(authors_list) if len(authors_list) > 1 else authors_list[0]
+copyright = f"2023-now {author}"
+
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',

docs/samgis_core.prediction_api.rst

@@ -4,10 +4,18 @@ samgis\_core.prediction\_api package
 Submodules
 ----------
 
-samgis\_core.prediction\_api.sam\_onnx module
----------------------------------------------
+samgis\_core.prediction\_api.sam\_onnx2 module
+----------------------------------------------
 
-.. automodule:: samgis_core.prediction_api.sam_onnx
+.. automodule:: samgis_core.prediction_api.sam_onnx2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_core.prediction\_api.sam\_onnx\_inference module
+--------------------------------------------------------
+
+.. automodule:: samgis_core.prediction_api.sam_onnx_inference
    :members:
    :undoc-members:
    :show-inheritance:

docs/samgis_core.utilities.rst

@@ -20,6 +20,14 @@ samgis\_core.utilities.fastapi\_logger module
    :undoc-members:
    :show-inheritance:
 
+samgis\_core.utilities.plot\_images module
+------------------------------------------
+
+.. automodule:: samgis_core.utilities.plot_images
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 samgis\_core.utilities.serialize module
 ---------------------------------------
 

samgis/__version__.py

@@ -5,4 +5,4 @@ try:
     __version__ = importlib.metadata.version(__package__ or __name__)
 except importlib.metadata.PackageNotFoundError or ImportError as e:
     print(f"metadata::e: {type(e)}, {e}: package installed?")
-    __version__ = "1.3.0"
+    __version__ = "1.5.1"