libinephany 0.17.0__tar.gz → 0.18.0__tar.gz

libinephany-0.18.0/CODE_VERSION.cfg

@@ -0,0 +1 @@
+0.18.0

{libinephany-0.17.0/libinephany.egg-info → libinephany-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libinephany
-Version: 0.17.0
+Version: 0.18.0
 Summary: Inephany library containing code commonly used by multiple subpackages.
 Author-email: Inephany <info@inephany.com>
 License: Apache 2.0

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/observations/observer_pipeline.py

@@ -218,7 +218,9 @@ class ObserverPipeline:
         tracked_statistics: dict[str, dict[str, float | TensorStatistics]],
         actions_taken: dict[str, float | int | None],
         return_dict: bool = False,
-    ) -> tuple[dict[str, list[float | int]], bool, dict[str, dict[str, list[float | int]]] | None]:
+    ) -> tuple[
+        dict[str, list[float | int]], bool, dict[str, dict[str, list[float | int] | dict[str, float | int]]] | None
+    ]:
         """
         :param observation_inputs: Observation input metrics not calculated with statistic trackers.
         :param hyperparameter_states: HyperparameterStates that manages the hyperparameters.
@@ -241,7 +243,7 @@ class ObserverPipeline:
         )
 
         local_obs: dict[str, list[float | int]] = {}
-        obs_as_dict: dict[str, dict[str, list[float | int]]] = {}
+        obs_as_dict: dict[str, dict[str, list[float | int] | dict[str, float | int]]] = {}
 
         for agent_id, agent_observers in self.local_observers.items():
             local_obs[agent_id], local_obs_dict = agent_observers.observe(

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/observations/observers/base_observers.py

@@ -204,16 +204,22 @@ class Observer(ABC):
         hyperparameter_states: HyperparameterStates,
         tracked_statistics: dict[str, dict[str, float | TensorStatistics]],
         action_taken: float | int | None,
-    ) -> list[float | int]:
+        return_dict: bool = False,
+    ) -> tuple[list[float | int], dict[str, float] | None]:
         """
         :param observation_inputs: Observation input metrics not calculated with statistic trackers.
         :param hyperparameter_states: HyperparameterStates that manages the hyperparameters.
         :param tracked_statistics: Dictionary mapping statistic tracker class names to dictionaries mapping module
         names to floats or TensorStatistic models.
         :param action_taken: Action taken by the agent this class instance is assigned to.
-        :return: List of floats or integers to add to the agent's observation vector.
+        :param return_dict: Whether to return a dictionary of observations as well as the normal vector.
+        :return: Tuple of:
+            - List of floats or integers to add to the agent's observation vector.
+            - Dictionary of specific observation values if the storage type is TensorStatistics and None otherwise.
         """
 
+        observations_dict: dict[str, float] | None = None
+
         observations = self._observe(
             observation_inputs=observation_inputs,
             hyperparameter_states=hyperparameter_states,
@@ -225,6 +231,9 @@ class Observer(ABC):
             self._cached_observation = deepcopy(observations)
 
         if self.observation_format is StatisticStorageTypes.TENSOR_STATISTICS:
+            if return_dict:
+                observations_dict = observations.as_observation_dict()  # type: ignore
+
             observations = observations.to_list(skip_statistics=self.skip_statistics)  # type: ignore
 
         observations = [observations] if not isinstance(observations, list) else observations  # type: ignore
@@ -241,7 +250,7 @@ class Observer(ABC):
         if not self._validated_observation:
             self._validate_observation(observations=observations)
 
-        return observations
+        return observations, observations_dict
 
     @final
     def inform(self) -> float | int | dict[str, float] | None:

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/observations/observers/observer_containers.py

@@ -135,7 +135,7 @@ class ObserverContainer(ABC):
         tracked_statistics: dict[str, dict[str, float | TensorStatistics]],
         action_taken: float | int | None,
         return_dict: bool = False,
-    ) -> tuple[list[float | int], dict[str, list[float | int]] | None]:
+    ) -> tuple[list[float | int], dict[str, list[float | int] | dict[str, float | int]] | None]:
         """
         :param observation_inputs: Observation input metrics not calculated with statistic trackers.
         :param hyperparameter_states: HyperparameterStates that manages the hyperparameters.
@@ -148,17 +148,21 @@ class ObserverContainer(ABC):
         """
 
         observations = []
-        observations_dict = {}
+        observations_dict: dict[str, list[float | int] | dict[str, float | int]] = {}
 
         for observer in self._observers:
-            observer_obs = observer.observe(
+            observer_obs, observer_obs_dict = observer.observe(
                 observation_inputs=observation_inputs,
                 hyperparameter_states=hyperparameter_states,
                 tracked_statistics=tracked_statistics,
                 action_taken=action_taken,
+                return_dict=return_dict,
             )
 
-            if return_dict:
+            if return_dict and observer_obs_dict is not None:
+                observations_dict[observer.__class__.__name__] = observer_obs_dict
+
+            elif return_dict:
                 observations_dict[observer.__class__.__name__] = observer_obs
 
             observations += observer_obs

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/observations/pipeline_coordinator.py

@@ -134,7 +134,7 @@ class ObserverPipelineCoordinator:
 
         clipped_observations = False
         observations = {}
-        observations_as_dict: dict[str, dict[str, list[float | int]]] = {}
+        observations_as_dict: dict[str, dict[str, list[float | int] | dict[str, float | int]]] = {}
 
         for pipeline in self.pipelines:
             pipeline_observations, pipeline_clipped_observations, pipeline_observations_dict = pipeline.observe(

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/pydantic_models/schemas/observation_models.py

@@ -51,7 +51,7 @@ class Observations(BaseModel):
     hit_invalid_value: bool
 
     agent_observations: dict[str, list[float | int]]
-    observations_as_dict: dict[str, dict[str, list[float | int]]] | None = None
+    observations_as_dict: dict[str, dict[str, list[float | int] | dict[str, float]]] | None = None
 
     def observations_as_arrays(self, dtype: DTypeLike = np.float32) -> dict[str, np.ndarray]:
         """

{libinephany-0.17.0 → libinephany-0.18.0}/libinephany/pydantic_models/schemas/tensor_statistics.py

@@ -7,6 +7,14 @@
 import torch
 from pydantic import BaseModel
 
+# ======================================================================================================================
+#
+# CONSTANTS
+#
+# ======================================================================================================================
+
+STRIP_SUFFIX = "_"
+
 # ======================================================================================================================
 #
 # CLASSES
@@ -252,3 +260,13 @@ class TensorStatistics(BaseModel):
                 self.inter_quartile_range,
             ]
         )
+
+    def as_observation_dict(self) -> dict[str, float]:
+        """
+        :return: Dictionary of observation values.
+        """
+
+        return {
+            field[:-1] if field.endswith(STRIP_SUFFIX) else field: field_value
+            for field, field_value in self.model_dump().items()
+        }

{libinephany-0.17.0 → libinephany-0.18.0/libinephany.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libinephany
-Version: 0.17.0
+Version: 0.18.0
 Summary: Inephany library containing code commonly used by multiple subpackages.
 Author-email: Inephany <info@inephany.com>
 License: Apache 2.0

libinephany-0.17.0/CODE_VERSION.cfg

@@ -1 +0,0 @@
-0.17.0