Merge pull request #844 from simvue-io/kzscisoft/833-add-support-for-multidimensional-metrics

Add support for multidimensional metrics

Author: kzscisoft

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Improves handling of Conda based environments in metadata collection.
 - Adds additional options to `Client.get_runs`.
 - Added ability to include environment variables within metadata for runs.
+- Added new feature allowing users to log tensors as multidimensional metrics after defining a grid.
 - Improves checks on `offline.cache` directory specification in config file.
 
 ## [v2.1.2](https://github.com/simvue-io/client/releases/tag/v2.1.2) - 2025-06-25

poetry.lock

@@ -8,28 +8,54 @@
 
 """
 
-from .administrator import Tenant as Tenant, User as User
+from .administrator import Tenant, User
 from .alert import (
-    Alert as Alert,
-    EventsAlert as EventsAlert,
-    MetricsThresholdAlert as MetricsThresholdAlert,
-    MetricsRangeAlert as MetricsRangeAlert,
-    UserAlert as UserAlert,
+    Alert,
+    EventsAlert,
+    MetricsThresholdAlert,
+    MetricsRangeAlert,
+    UserAlert,
 )
 from .storage import (
-    S3Storage as S3Storage,
-    FileStorage as FileStorage,
-    Storage as Storage,
+    S3Storage,
+    FileStorage,
+    Storage,
 )
 from .artifact import (
-    FileArtifact as FileArtifact,
-    ObjectArtifact as ObjectArtifact,
-    Artifact as Artifact,
+    FileArtifact,
+    ObjectArtifact,
+    Artifact,
 )
 
-from .stats import Stats as Stats
-from .run import Run as Run
-from .tag import Tag as Tag
-from .folder import Folder as Folder, get_folder_from_path as get_folder_from_path
+from .stats import Stats
+from .run import Run
+from .tag import Tag
+from .folder import Folder, get_folder_from_path
 from .events import Events as Events
 from .metrics import Metrics as Metrics
+from .grids import Grid, GridMetrics
+
+__all__ = [
+    "Grid",
+    "GridMetrics",
+    "Metrics",
+    "Events",
+    "get_folder_from_path",
+    "Folder",
+    "Stats",
+    "Run",
+    "Tag",
+    "Artifact",
+    "FileArtifact",
+    "ObjectArtifact",
+    "S3Storage",
+    "FileStorage",
+    "Storage",
+    "MetricsRangeAlert",
+    "MetricsThresholdAlert",
+    "UserAlert",
+    "EventsAlert",
+    "Alert",
+    "Tenant",
+    "User",
+]

simvue/api/objects/__init__.py

@@ -461,10 +461,22 @@ def count(cls, **kwargs) -> int:
 
     @classmethod
     def _get_all_objects(
-        cls, offset: int | None, count: int | None, **kwargs
+        cls,
+        offset: int | None,
+        count: int | None,
+        endpoint: str | None = None,
+        expected_type: type = dict,
+        **kwargs,
     ) -> typing.Generator[dict, None, None]:
         _class_instance = cls(_read_only=True)
-        _url = f"{_class_instance._base_url}"
+
+        # Allow the possibility of paginating a URL that is not the
+        # main class endpoint
+        _url = (
+            f"{_class_instance._user_config.server.url}/{endpoint}"
+            if endpoint
+            else f"{_class_instance._base_url}"
+        )
 
         _label = _class_instance.__class__.__name__.lower()
         if _label.endswith("s"):
@@ -473,12 +485,18 @@ def _get_all_objects(
         for response in get_paginated(
             _url, headers=_class_instance._headers, offset=offset, count=count, **kwargs
         ):
-            yield get_json_from_response(
+            _generator = get_json_from_response(
                 response=response,
                 expected_status=[http.HTTPStatus.OK],
                 scenario=f"Retrieval of {_label}s",
+                expected_type=expected_type,
             )  # type: ignore
 
+            if expected_type is dict:
+                yield _generator
+            else:
+                yield from _generator
+
     def read_only(self, is_read_only: bool) -> None:
         """Set whether this object is in read only state.
 
@@ -552,14 +570,16 @@ def url(self) -> URL | None:
         """
         return None if self._identifier is None else self._base_url / self._identifier
 
-    def _post(self, is_json: bool = True, **kwargs) -> dict[str, typing.Any]:
+    def _post(
+        self, *, is_json: bool = True, data: list | dict | None = None, **kwargs
+    ) -> dict[str, typing.Any]:
         if not is_json:
-            kwargs = msgpack.packb(kwargs, use_bin_type=True)
+            kwargs = msgpack.packb(data or kwargs, use_bin_type=True)
         _response = sv_post(
             url=f"{self._base_url}",
             headers=self._headers | {"Content-Type": "application/msgpack"},
             params=self._params,
-            data=kwargs,
+            data=data or kwargs,
             is_json=is_json,
         )