nimbro-api 0.2.2__tar.gz → 0.2.3__tar.gz

{nimbro_api-0.2.2/src/nimbro_api.egg-info → nimbro_api-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nimbro-api
-Version: 0.2.2
+Version: 0.2.3
 Summary: A robust and flexible framework for API clients in Python
 Author-email: Bastian Pätzold <paetzoldbastian@gmail.com>
 Maintainer-email: Bastian Pätzold <paetzoldbastian@gmail.com>

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nimbro-api"
-version = "0.2.2"
+version = "0.2.3"
 description = "A robust and flexible framework for API clients in Python"
 readme = "README.md"
 license = "BSD-3-Clause"

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/misc/client/no.py

@@ -28,6 +28,16 @@ class No(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the no-as-a-service API (https://github.com/hotheadhacker/no-as-a-service).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=NoBase, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -45,13 +55,13 @@ class No(Client):
                 Logger severity in ["debug", "info", "warn", "error", "fatal", "off"] (str) or `None` to adopt global process-wide severity.
             logger_name (str | None):
                 Logger name shown in each log identifying this object.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the v1 Chat Completions API.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
-                - The value of 'key_type' must be either "environment" or "plain".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required key 'api_url'.
+                - All values must be non-empty strings (`str`).
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             timeout_connect (float | int | None):
                 Time in seconds waited for connecting to the 'endpoint', or `None` to wait indefinitely.
             timeout_read (float | int | None):
@@ -80,6 +90,7 @@ class No(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/misc/client/vlm_gist.py

@@ -112,6 +112,16 @@ class VlmGist(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing VLM-GIST (https://arxiv.org/abs/2503.16538).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=VlmGistBase, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -221,6 +231,7 @@ class VlmGist(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/misc/test/vlm_gist_test.py

@@ -592,6 +592,11 @@ def test_13_parallel_threads(n=10):
 
 def test_14_parallel_multiprocessing(n=10):
     client = VlmGist(settings={
+        'scene_description.chat_completions.logger_severity': "off",
+        'structured_description.chat_completions.logger_severity': "off",
+        'detection.mmgroundingdino.logger_severity': "off",
+        'segmentation.sam2_realtime.logger_severity': "off",
+        'batch.logger_severity': "off",
         'batch.size': n,
         'batch.style': "multiprocessing",
         'batch.retry': 2,

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/nimbro_vision_servers/client/dam.py

@@ -44,6 +44,16 @@ class Dam(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the NimbRo Vision Servers API for the Describe Anything Model (https://github.com/AIS-Bonn/nimbro_vision_servers/tree/main/models/dam).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=DamBase, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -63,14 +73,14 @@ class Dam(Client):
                 Logger name shown in each log identifying this object.
             message_results (bool):
                 Include results in successful response messages when using `get_descriptions()`.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the NimbRo Vision Servers API for the Describe Anything Model.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required keys 'api_flavor', 'api_url', 'key_type', and 'key_value'.
                 - The value of 'key_type' must be either "environment" or "plain".
-                - All values must be non-empty strings (`str`).
+                - All values must be non-empty strings (`str`), except 'key_value', which may be empty.
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             validate_health (float | int | bool):
                 Validate the set 'endpoint' is healthy when using `get_descriptions()`:
                 - Use `float` or `int` to set the time in seconds permitted for cached responses to be reused before requesting a new one.
@@ -125,6 +135,7 @@ class Dam(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/nimbro_vision_servers/client/florence2.py

@@ -42,6 +42,16 @@ class Florence2(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the NimbRo Vision Servers API for Florence-2 (https://github.com/AIS-Bonn/nimbro_vision_servers/tree/main/models/florence2).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=Florence2Base, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -61,14 +71,14 @@ class Florence2(Client):
                 Logger name shown in each log identifying this object.
             message_results (bool):
                 Include results in successful response messages when using `get_response()`.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the NimbRo Vision Servers API for Florence-2.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required keys 'api_flavor', 'api_url', 'key_type', and 'key_value'.
                 - The value of 'key_type' must be either "environment" or "plain".
-                - All values must be non-empty strings (`str`).
+                - All values must be non-empty strings (`str`), except 'key_value', which may be empty.
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             validate_health (float | int | bool):
                 Validate the set 'endpoint' is healthy when using `get_response()`:
                 - Use `float` or `int` to set the time in seconds permitted for cached responses to be reused before requesting a new one.
@@ -121,6 +131,7 @@ class Florence2(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/nimbro_vision_servers/client/kosmos2.py

@@ -42,6 +42,16 @@ class Kosmos2(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the NimbRo Vision Servers API for Kosmos-2 (https://github.com/AIS-Bonn/nimbro_vision_servers/tree/main/models/kosmos2).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=Kosmos2Base, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -61,14 +71,14 @@ class Kosmos2(Client):
                 Logger name shown in each log identifying this object.
             message_results (bool):
                 Include results in successful response messages when using `get_response()`.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the NimbRo Vision Servers API for Kosmos-2.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required keys 'api_flavor', 'api_url', 'key_type', and 'key_value'.
                 - The value of 'key_type' must be either "environment" or "plain".
-                - All values must be non-empty strings (`str`).
+                - All values must be non-empty strings (`str`), except 'key_value', which may be empty.
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             validate_health (float | int | bool):
                 Validate the set 'endpoint' is healthy when using `get_response()`:
                 - Use `float` or `int` to set the time in seconds permitted for cached responses to be reused before requesting a new one.
@@ -119,6 +129,7 @@ class Kosmos2(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/nimbro_vision_servers/client/mmgroundingdino.py

@@ -41,6 +41,16 @@ class MmGroundingDino(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the NimbRo Vision Servers API for MM-Grounding-DINO and LLMDet (https://github.com/AIS-Bonn/nimbro_vision_servers/tree/main/models/mmgroundingdino).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=MmGroundingDinoBase, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -60,14 +70,14 @@ class MmGroundingDino(Client):
                 Logger name shown in each log identifying this object.
             message_results (bool):
                 Include results in successful response messages when using `get_detections()`.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the NimbRo Vision Servers API for MM-Grounding-DINO and LLMDet.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required keys 'api_flavor', 'api_url', 'key_type', and 'key_value'.
                 - The value of 'key_type' must be either "environment" or "plain".
-                - All values must be non-empty strings (`str`).
+                - All values must be non-empty strings (`str`), except 'key_value', which may be empty.
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             validate_health (float | int | bool):
                 Validate the set 'endpoint' is healthy when using `get_detections()`:
                 - Use `float` or `int` to set the time in seconds permitted for cached responses to be reused before requesting a new one.
@@ -121,6 +131,7 @@ class MmGroundingDino(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.

{nimbro_api-0.2.2 → nimbro_api-0.2.3}/src/nimbro_api/api/nimbro_vision_servers/client/sam2_realtime.py

@@ -37,6 +37,16 @@ class Sam2Realtime(Client):
     def __init__(self, settings=None, **kwargs):
         """
         Create an Client implementing the NimbRo Vision Servers API for the Segment Anything Model 2 real-time (https://github.com/AIS-Bonn/nimbro_vision_servers/tree/main/models/sam2_realtime).
+
+        Args:
+            settings (dict | None, optional):
+                Settings initializing the object. Settings not contained are initialized to their default values.
+                See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
+                Use `None` to initialize with default settings. Defaults to `None`.
+            **kwargs:
+                All settings (see `get_settings()`) can also be initialized via keyword arguments.
+                When doing so, 'settings' must be `None` or an empty `dict`.
         """
         super().__init__(client_base=Sam2RealtimeBase, settings=settings, default_settings=default_settings, **kwargs)
 
@@ -56,14 +66,14 @@ class Sam2Realtime(Client):
                 Logger name shown in each log identifying this object.
             message_results (bool):
                 Include results in successful response messages when using `get_response()`.
-            endpoints (dict[dict]):
-                Endpoint definitions pointing to providers of the NimbRo Vision Servers API for the Segment Anything Model 2 real-time.
-                - Each endpoint must be a dictionary (`dict`), with the required keys "api_url", "key_type", and "key_value".
+            endpoints (dict):
+                Endpoint definitions mapping names (`str`) to endpoints/providers (`dict`) of the targeted API.
+                - Each endpoint must be a dictionary (`dict`), with the required keys 'api_flavor', 'api_url', 'key_type', and 'key_value'.
                 - The value of 'key_type' must be either "environment" or "plain".
-                - All values must be non-empty strings (`str`).
+                - All values must be non-empty strings (`str`), except 'key_value', which may be empty.
             endpoint (str | dict):
-                Name of the endpoint to be used from the list of defined 'endpoints'.
-                Pass an endpoint definition (`dict`) to automatically add/update the definition and select it.
+                Name of the defined endpoint to be used from the list of keys in setting 'endpoints'.
+                Pass an endpoint definition (`dict`) with the addional key 'name' to automatically add/update the setting 'endpoints' and select it.
             validate_health (float | int | bool):
                 Validate the set 'endpoint' is healthy when using `get_response()`:
                 - Use `float` or `int` to set the time in seconds permitted for cached responses to be reused before requesting a new one.
@@ -107,6 +117,7 @@ class Sam2Realtime(Client):
             settings (dict | None, optional):
                 New settings to apply. Settings not contained are kept.
                 See the documentation of `get_settings()` for a comprehensive list of all available settings.
+                Nested settings can be specified using dot-separated keys (e.g., "a.b.c" is equivalent to {"a": {"b": {"c": ...}}}).
                 Use `None` to reset all settings to their initial values. Defaults to `None`.
             **kwargs:
                 All settings (see `get_settings()`) can also be configured via keyword arguments.