doc: update changelog, openapi specs, conf and content documentation

docs/Changelog.md

@@ -1,6 +1,34 @@
 # Changelog
 
-## Version 1.11.9 - 1.11.19
+## Version 1.12.1
+
+- ci: update requirements.txt with the updated, installed dependency versions
+- ci: revert to dockerfiles based on python debian/trixie image
+- ci: remove old dockerfiles for AWS, add alpine-linux base dockerfile
+- ci: update base dockerfile version to 1.12.1
+- doc: update changelog, openapi specs, conf and content documentation
+- chore: update samgis-web==1.3.1, pytest and docs dependencies
+- chore: rollback to onnxruntime as direct dependency
+
+## Version 1.12.0 (Not released)
+
+- test: refactored test execution
+- test: avoid using assert construct
+- ci: now dockerfiles are based on alpine linux
+- ci: move onnxruntime dependency requirement to a optional group, preparing alpine linux docker image
+- feat: add a python script (scripts/client_health.py) to perform the health check avoiding curl use
+- chore: refactor pyproject.toml, max python version is 3.13
+
+## Version 1.11.14 - 1.11.19
+
+Bugfix only
+
+## Version 1.11.13
+
+- test: fix test case condition about the number of shapely geometries created from the samgis post
+- feat: remove ButtonMapSendRequest used in desktop mode to avoid wrong references on driver.js tour
+
+## Version 1.11.9 - 1.11.12
 
 Bugfix only
 

docs/conf.py

@@ -5,27 +5,34 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-import os
-import sys
 import tomllib
+import pathlib
 
 
 project = 'SamGIS'
 
 # -- 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_path = pathlib.Path(__file__).parent.parent / 'pyproject.toml'
+with open(toml_path, "rb") as f:
     toml = tomllib.load(f)
 
-pyproject = toml["tool"]["poetry"]
+pyproject = toml["project"]
 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]
+authors_list = [a for a in pyproject["authors"]]
+author = ""
+for author_element in authors_list:
+    if len(author) > 1:
+        author += ", "
+    if isinstance(author_element, str):
+        author += f"{author_element}"
+    else:
+        name = author_element.get("name")
+        email = author_element.get("email")
+        author += f"{name} <{email}>"
+
 copyright = f"2023-now {author}"
 
 extensions = [
@@ -39,11 +46,13 @@ extensions = [
 ]
 # Napoleon settings
 napoleon_google_docstring = True
+# sphinx_autodoc_typehints settings
 typehints_defaults = "comma"
 
 templates_path = ['_templates']
 exclude_patterns = [
-    '_build', 'Thumbs.db', '.DS_Store', 'build/*', 'machine_learning_models', 'machine_learning_models/*', "sam-quantized/machine_learning_models", "sam-quantized/machine_learning_models/*"
+    '_build', 'Thumbs.db', '.DS_Store', 'build/*', 'machine_learning_models', 'machine_learning_models/*',
+    "sam-quantized/machine_learning_models", "sam-quantized/machine_learning_models/*"
 ]
 
 source_suffix = {

docs/external_links_md.md

@@ -1,4 +1,4 @@
-- My [SamGIS demo website](https://ml-trinca.tornidor.com)
-- My [HuggingFace SamGIS demo](https://huggingface.co/spaces/aletrn/samgis)
-- My [HuggingFace SamGIS - LISA on CUDA demo](https://huggingface.co/spaces/aletrn/samgis-lisa-on-cuda)
+- My [HuggingFace SamGIS direct link space](https://aletrn-samgis.hf.space/)
+- My [HuggingFace SamGIS space](https://huggingface.co/spaces/aletrn/samgis)
+- My [HuggingFace SamGIS space - LISA on CUDA demo](https://huggingface.co/spaces/aletrn/samgis-lisa-on-cuda)
 - My [personal website](https://trinca.tornidor.com)

docs/openapi.rst

@@ -1,11 +1,10 @@
 OpenAPI Specs
 =============
 
-This API is under oauth authentication for the self-hosted version (now it works as a lambda AWS).
-Contact the maintainer/administrator for more info about this.
+The OpenAPI specifications for the SamGIS app.
 
 .. openapi:: specs/openapi.yaml
    :paths:
-      /lambda-ml-fastsam-api
+      /infer_samgis
    :examples:
    :encoding: utf-8

docs/specs/openapi.yaml

@@ -4,7 +4,8 @@ info:
   description: |-
     Segment Anything applied to GIS.
     Some useful links:
-    - [SamGIS online demo](https://ml-trinca.tornidor.com)
+    - [SamGIS HuggingFace space direct link](https://huggingface.co/spaces/aletrn/samgis)
+    - [SamGIS HuggingFace space](https://huggingface.co/spaces/aletrn/samgis)
     - [SamGIS documentation](https://docs.ml-trinca.tornidor.com)
     - [My blog](https://trinca.tornidor.com)
   contact:
@@ -13,7 +14,7 @@ info:
   license:
     name: MIT License
     url: https://opensource.org/license/mit/
-  version: "1.2.0"
+  version: "1.3.1"
 servers:
   - url: https://localhost:8000/
 tags:
@@ -33,13 +34,21 @@ tags:
     externalDocs:
       url: https://it.wikipedia.org/wiki/Geographic_information_system
 paths:
-  /lambda-ml-fastsam-api:
+  /health:
+    get:
+      summary: Health
+      operationId: health_health_get
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema: {}
+  /infer_samgis:
     post:
-      tags:
-        - samgis
-      summary: Make GIS ML predictions
+      summary: Infer Samgis
+      operationId: infer_samgis_infer_samgis_post
       requestBody:
-        description: input request for GIS ML predictions
         content:
           application/json:
             schema:
@@ -47,131 +56,169 @@ paths:
         required: true
       responses:
         '200':
-          description: successful operation
+          description: Successful Response
           content:
             application/json:
-              schema:
-                $ref: '#/components/schemas/ApiResponseBodySuccess'
-        '400':
-          description: Bad request
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ApiResponseBodyFailure'
+              schema: {}
         '422':
-          description: Unprocessable Entity
+          description: Validation Error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ApiResponseBodyFailure'
-        '500':
-          description: Internal Server Error
+                $ref: '#/components/schemas/HTTPValidationError'
+  /:
+    get:
+      summary: Index
+      operationId: index__get
+      responses:
+        '200':
+          description: Successful Response
           content:
             application/json:
-              schema:
-                $ref: '#/components/schemas/ApiResponseBodyFailure'
+              schema: {}
 components:
   schemas:
     ApiRequestBody:
-      required:
-        - bbox
-        - prompt
-        - zoom
-      type: object
       properties:
+        id:
+          type: string
+          title: Id
+          default: ''
         bbox:
-          type: object
-          properties:
-            ne:
-              type: object
-              properties:
-                lat:
-                  type: number
-                  example: 46.180194387028855
-                lng:
-                  type: number
-                  example: 9.426848938165525
-            sw:
-              type: object
-              properties:
-                lat:
-                  type: number
-                  example: 46.17511301243843
-                lng:
-                  type: number
-                  example: 9.415862610040527
+          $ref: '#/components/schemas/RawBBox'
         prompt:
-          type: array
           items:
-            type: object
-            properties:
-              id:
-                type: integer
-                format: int32
-                example: 448
-              type:
-                type: string
-                example: point
-              data:
-                type: object
-                properties:
-                  lat:
-                    type: number
-                    example: 46.176256754439535
-                  lng:
-                    type: number
-                    example: 9.421805260519237
-              label:
-                type: integer
-                format: int32
-                example: 1
+            anyOf:
+            - $ref: '#/components/schemas/RawPromptPoint'
+            - $ref: '#/components/schemas/RawPromptRectangle'
+          type: array
+          title: Prompt
         zoom:
-          type: integer
-          format: int32
-          example: 17
+          anyOf:
+          - type: integer
+          - type: number
+          title: Zoom
         source_type:
           type: string
-          example: OpenStreetMap
-    ApiResponseBodyFailure:
+          title: Source Type
+          default: OpenStreetMap.Mapnik
+        debug:
+          type: boolean
+          title: Debug
+          default: false
       type: object
+      required:
+      - bbox
+      - prompt
+      - zoom
+      title: ApiRequestBody
+      description: Input request validator type (not yet parsed)
+    HTTPValidationError:
       properties:
-        duration_run:
-          type: number
-          example: 0.063
-        message:
-          type: string
-          example: Bad Request
-        request_id:
-          type: string
-          example: test_invoke_id
-    ApiResponseBodySuccess:
+        detail:
+          items:
+            $ref: '#/components/schemas/ValidationError'
+          type: array
+          title: Detail
       type: object
+      title: HTTPValidationError
+    LatLngDict:
       properties:
-        n_predictions:
-          type: integer
-          format: int32
-          example: 1
-        geojson:
-          type: string
-          example: '{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"raster_val":255.0},"geometry":{"type":"Polygon","coordinates":[[[9.415857195854185,46.17510931936532],[9.426854252815245,46.17510931936532],[9.426854252815245,46.18019812286394],[9.415857195854185,46.18019812286394],[9.415857195854185,46.17510931936532]]]},"id":0},{"type":"Feature","properties":{"raster_val":0.0},"geometry":{"type":"Polygon","coordinates":[[[9.143199920654297,46.30271068141335],[9.495105743408203,46.30271068141335],[9.495105743408203,46.13999860748669],[9.143199920654297,46.13999860748669],[9.143199920654297,46.30271068141335]],[[9.426854252815245,46.17510931936532],[9.426854252815245,46.18019812286394],[9.415857195854185,46.18019812286394],[9.415857195854185,46.17510931936532],[9.426854252815245,46.17510931936532]]]},"id":1}]}'
-        n_shapes_geojson:
-          type: integer
-          format: int32
-          example: 5
-        duration_run:
+        lat:
           type: number
-          example: 6.703
-        message:
+          title: Lat
+        lng:
+          type: number
+          title: Lng
+      type: object
+      required:
+      - lat
+      - lng
+      title: LatLngDict
+      description: Generic geographic latitude-longitude type
+    PromptLabel:
+      type: integer
+      enum:
+      - 0
+      - 1
+      title: PromptLabel
+      description: Valid prompt label type
+    PromptPointType:
+      type: string
+      enum:
+      - point
+      title: PromptPointType
+      description: 'Segment Anything: validation point prompt type'
+    PromptRectangleType:
+      type: string
+      enum:
+      - rectangle
+      title: PromptRectangleType
+      description: 'Segment Anything: validation rectangle prompt type'
+    RawBBox:
+      properties:
+        ne:
+          $ref: '#/components/schemas/LatLngDict'
+        sw:
+          $ref: '#/components/schemas/LatLngDict'
+      type: object
+      required:
+      - ne
+      - sw
+      title: RawBBox
+      description: Input lambda bbox request type (not yet parsed)
+    RawPromptPoint:
+      properties:
+        type:
+          $ref: '#/components/schemas/PromptPointType'
+        data:
+          $ref: '#/components/schemas/LatLngDict'
+        label:
+          $ref: '#/components/schemas/PromptLabel'
+      type: object
+      required:
+      - type
+      - data
+      - label
+      title: RawPromptPoint
+      description: Input lambda prompt request of type 'PromptPointType' - point (not
+        yet parsed)
+    RawPromptRectangle:
+      properties:
+        type:
+          $ref: '#/components/schemas/PromptRectangleType'
+        data:
+          $ref: '#/components/schemas/RawBBox'
+      type: object
+      required:
+      - type
+      - data
+      title: RawPromptRectangle
+      description: Input lambda prompt request of type 'PromptRectangleType' - rectangle
+        (not yet parsed)
+    ValidationError:
+      properties:
+        loc:
+          items:
+            anyOf:
+            - type: string
+            - type: integer
+          type: array
+          title: Location
+        msg:
           type: string
-          example: ok
-        request_id:
+          title: Message
+        type:
           type: string
-          example: test_invoke_id
-  securitySchemes:
-    samgis_auth:
-      type: oauth2
-      flows:
-        implicit:
-          authorizationUrl: https://example.auth0.com/oauth/authorize
-          scopes:
-            write:lambda-ml-fastsam-api: Make GIS ML predictions
+          title: Error Type
+        input:
+          title: Input
+        ctx:
+          type: object
+          title: Context
+      type: object
+      required:
+      - loc
+      - msg
+      - type
+      title: ValidationError

scripts/extract-openapi-fastapi.py

@@ -3,18 +3,20 @@ import argparse
 import json
 import logging
 import sys
+from pathlib import Path
 
 import yaml
 from uvicorn.importer import import_from_string
 
-from app import project_root_folder
+# from app import project_root_folder
 
 
 if __name__ == "__main__":  # pragma: no cover
     # python scripts/extract-openapi.py fastapi_wrapper:app --app-dir wrappers --out docs/specs/openapi_new.yaml
     parser = argparse.ArgumentParser(prog="extract-openapi-fastapi.py")
-    parser.add_argument("app",       help='App import string. Eg. "main:app"', default="main:app")
-    parser.add_argument("--app-dir", help="Directory containing the app", default=None)
+    parser.add_argument("app",       help='App import string. Eg. "app:app"', default="app:app")
+    project_root_folder = Path(__file__).parent.parent
+    parser.add_argument("--app-dir", help="Directory containing the app", default=str(project_root_folder))
     args = parser.parse_args()
 
     if args.app_dir is not None: