[doc] update docs, bump to version 1.3.0

docs/Changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Version 1.3.0
+- take advantage of re-usable image embeddings in SAM model using samgis_core@1.1.1
+- add map navigation locking (unlockable!) on ML request to take advantage of image embedding re-use
+- add a metadata section within the pyproject.toml file
+
 ## Version 1.2.2
 - update dependencies version
 

docs/brief_project_presentation.md

@@ -7,14 +7,15 @@ The backend perform machine learning inference using a [Segment Anything](https:
 
 Check about implementation details on my [blog](https://trinca.tornidor.com/projects/samgis-segment-anything-applied-to-GIS).
 
-# Self-hosted demo
+## Self-hosted demo
 
 You can visit my self-hosted demo [here](https://ml-trinca.tornidor.com).
 Since this demo uses a python container backend hosted on my AWS account I keep it under authentication to prevent abuses.
 [Here](https://docs.ml-trinca.tornidor.com/openapi) the OpenAPI swagger documentation.
 
-# HuggingFace Space demo
+## HuggingFace Space demo
 
 I added also a demo on this [HuggingFace Space](https://huggingface.co/spaces/aletrn/samgis). It's
-possible to find [here](https://aletrn-samgis.hf.space/) the direct space url and 
-[here](https://aletrn-samgis.hf.space/docs#/) the OpenAPI swagger documentation.
+possible to find [here](https://aletrn-samgis.hf.space/) the direct space url and [here](https://aletrn-samgis.hf.space/docs#/) the OpenAPI swagger documentation.
+
+Another interesting resource is my [HuggingFace SamGIS - LISA on CUDA demo](https://huggingface.co/spaces/aletrn/samgis-lisa-on-cuda): you can find some details about it on [its project page](https://trinca.tornidor.com/projects/lisa-adapted-for-samgis).

docs/conf.py

@@ -11,7 +11,7 @@ import sys
 project = 'SamGIS'
 copyright = '2023-now, alessandro trinca tornidor'
 author = 'alessandro trinca tornidor'
-release = '1.2.2'
+release = '1.3.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -28,8 +28,6 @@ extensions = [
 ]
 # Napoleon settings
 napoleon_google_docstring = True
-
-#
 typehints_defaults = "comma"
 
 templates_path = ['_templates']
@@ -43,13 +41,6 @@ source_suffix = {
     '.md': 'markdown',
 }
 
-# default args values
-rst_prolog = """
-.. |default| raw:: html
-
-    <div class="default-value-section">""" + \
-    ' <span class="default-value-label">Default:</span>'
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/modules.rst

@@ -1,7 +1,8 @@
-samgis
-======
+modules
+=======
 
 .. toctree::
    :maxdepth: 4
 
    samgis
+   samgis_core

docs/samgis_core.prediction_api.rst

@@ -0,0 +1,21 @@
+samgis\_core.prediction\_api package
+====================================
+
+Submodules
+----------
+
+samgis\_core.prediction\_api.sam\_onnx module
+---------------------------------------------
+
+.. automodule:: samgis_core.prediction_api.sam_onnx
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: samgis_core.prediction_api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/samgis_core.rst

@@ -0,0 +1,19 @@
+samgis\_core package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   samgis_core.prediction_api
+   samgis_core.utilities
+
+Module contents
+---------------
+
+.. automodule:: samgis_core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/samgis_core.utilities.rst

@@ -0,0 +1,53 @@
+samgis\_core.utilities package
+==============================
+
+Submodules
+----------
+
+samgis\_core.utilities.constants module
+---------------------------------------
+
+.. automodule:: samgis_core.utilities.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_core.utilities.fastapi\_logger module
+---------------------------------------------
+
+.. automodule:: samgis_core.utilities.fastapi_logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_core.utilities.serialize module
+---------------------------------------
+
+.. automodule:: samgis_core.utilities.serialize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_core.utilities.type\_hints module
+-----------------------------------------
+
+.. automodule:: samgis_core.utilities.type_hints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_core.utilities.utilities module
+---------------------------------------
+
+.. automodule:: samgis_core.utilities.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: samgis_core.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:

poetry.lock

@@ -2130,22 +2130,24 @@ files = [
 
 [[package]]
 name = "samgis-core"
-version = "1.1.1"
+version = "1.1.2"
 description = "SamGIS CORE"
 optional = false
-python-versions = "<3.11,>=3.10"
-files = [
-    {file = "samgis_core-1.1.1-py3-none-any.whl", hash = "sha256:720849ac4c43ad17e52db0702ff8c1bafa6cdcbb00a5128777b957ad1da1950f"},
-    {file = "samgis_core-1.1.1.tar.gz", hash = "sha256:3f779cbb75b5555f0f27f9d473f7d311c3d170a6164867bb5fa5768bce74b1f4"},
-]
+python-versions = "~3.10"
+files = []
+develop = false
 
 [package.dependencies]
-bson = ">=0.5.10,<0.6.0"
-loguru = ">=0.7.2,<0.8.0"
+bson = "^0.5.10"
+loguru = "^0.7.2"
 numpy = "1.25.2"
 onnxruntime = "1.16.3"
 opencv-python-headless = "4.8.1.78"
-pillow = ">=10.2.0,<11.0.0"
+pillow = "^10.2.0"
+
+[package.source]
+type = "directory"
+url = "../samgis_core"
 
 [[package]]
 name = "setuptools"
@@ -2399,6 +2401,24 @@ docs = ["sphinxcontrib-websupport"]
 lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-simplify", "isort", "mypy (>=0.990)", "ruff", "sphinx-lint", "types-requests"]
 test = ["cython (>=3.0)", "filelock", "html5lib", "pytest (>=4.6)", "setuptools (>=67.0)"]
 
+[[package]]
+name = "sphinx-autodoc-defaultargs"
+version = "0.1.2"
+description = "Automatic generation of default arguments for the Sphinx autodoc extension."
+optional = false
+python-versions = ">=3.5"
+files = [
+    {file = "sphinx-autodoc-defaultargs-0.1.2.tar.gz", hash = "sha256:b11cd9ac43510c1f1e9a3f9469a370e6bbe2bc2cb9e67cb79987f4dcd3be5be3"},
+    {file = "sphinx_autodoc_defaultargs-0.1.2-py3-none-any.whl", hash = "sha256:1513b1aea8c20348f1763dbfd7ff11f86cd77f2ce3246c73e1405a2a67fea3ff"},
+]
+
+[package.dependencies]
+Sphinx = ">=3.0"
+
+[package.extras]
+test = ["Sphinx (>=3.2.0)", "dataclasses", "pytest (>=3.1.0)", "sphobjinv (>=2.0)", "typing-extensions (>=3.5)"]
+type-comments = ["typed-ast (>=1.4.0)"]
+
 [[package]]
 name = "sphinx-autodoc-typehints"
 version = "1.25.3"
@@ -2691,4 +2711,4 @@ files = [
 [metadata]
 lock-version = "2.0"
 python-versions = "~3.10"
-content-hash = "9da4b1507746895d408c11d51a135665fee578a3f7c497d8018a252a853a9e56"
+content-hash = "c976c4dd1ee54e5bc8a77e978c4462771f4f2729ff1a2272885f588219c91e41"

pyproject.toml

@@ -1,11 +1,15 @@
 [tool.poetry]
 name = "samgis"
-version = "1.2.2"
+version = "1.3.0"
 description = "A backend for machine learning instance segmentation on geospatial data even without dedicated graphics cards."
 authors = ["alessandro trinca tornidor <alessandro@trinca.tornidor.com>"]
 license = "MIT license"
 readme = "README.md"
 
+[metadata]
+name = "samgis"
+version = "1.3.0"
+
 [tool.poetry.dependencies]
 bson = "^0.5.10"
 contextily = "^1.5.2"
@@ -19,7 +23,7 @@ python = "~3.10"
 python-dotenv = "^1.0.1"
 rasterio = "^1.3.9"
 requests = "^2.31.0"
-samgis-core = "^1.1.1"
+samgis-core = "^1.1.2"
 
 [tool.poetry.group.aws_lambda]
 optional = true
@@ -47,6 +51,7 @@ sphinx = "^7.2.6"
 sphinx-autodoc-typehints = "^1.25.2"
 sphinxcontrib-openapi = "^0.8.4"
 myst-parser = "^2.0.0"
+sphinx-autodoc-defaultargs = "^0.1.2"
 
 [tool.poetry.group.fastapi]
 optional = true

samgis/__version__.py

@@ -1 +1,4 @@
-__version__ = "1.2.2"
+import importlib.metadata
+
+
+__version__ = importlib.metadata.version(__package__ or __name__)