libinephany 0.16.5__py3-none-any.whl → 0.18.0__py3-none-any.whl

libinephany/observations/observation_utils.py

@@ -64,8 +64,10 @@ def get_exponential_weighted_average(values: list[int | float]) -> float:
     :param values: List of values to average via EWA.
     :return: EWA of the given values.
     """
+
     exp_weighted_average = pd.Series(values).ewm(alpha=0.1).mean().iloc[-1]
     assert isinstance(exp_weighted_average, float)
+
     return exp_weighted_average
 
 

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.
@@ -226,8 +228,10 @@ class ObserverPipeline:
         names to floats or TensorStatistic models.
         :param actions_taken: Dictionary mapping agent IDs to actions taken by that agent.
         :param return_dict: Whether to return a dictionary of observations as well as the normal vector.
-        :return: Tuple of a dictionary mapping agent ID to that agent's completed observation vector, a boolean
-        indicating whether an observation clip occurred and a dictionary of observations.
+        :return: Tuple of:
+         - A dictionary mapping agent ID to that agent's completed observation vector,
+         - A boolean indicating whether an observation clip occurred,
+         - A dictionary mapping agent ID to a dictionary mapping observer name to that observer's observation vector.
         """
 
         global_obs, global_obs_dict = self.global_observers.observe(
@@ -239,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/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/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/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/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/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/utils/constants.py

@@ -8,6 +8,7 @@ KEY_HEADER_CASE = "X-API-Key"
 KEY_HEADER_NO_CASE = KEY_HEADER_CASE.lower()
 
 TIMESTAMP_FORMAT = "%Y-%m-%d-%H-%M-%S"
+TIMESTAMP_FORMAT_WITH_MS = "%Y-%m-%d-%H-%M-%S-%f"
 
 RLLIB_TRUNC_EPISODES = "truncate_episodes"
 RLLIB_COMP_EPISODES = "complete_episodes"

{libinephany-0.16.5.dist-info → libinephany-0.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libinephany
-Version: 0.16.5
+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.16.5.dist-info → libinephany-0.18.0.dist-info}/RECORD

@@ -2,15 +2,15 @@ libinephany/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/aws/s3_functions.py,sha256=W8u85A6tDloo4FlJvydJbVHCUq_m9i8KDGdnKzy-Xpg,1745
 libinephany/observations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-libinephany/observations/observation_utils.py,sha256=CXep6CVvzgh8I_SSmZvyupQLiwDzKDEiVLYqidhnL-A,16264
-libinephany/observations/observer_pipeline.py,sha256=RvMH-TTDTu1Nk4S_KSHDkII1YuIRMSOXkPhn6g4B9ow,12815
-libinephany/observations/pipeline_coordinator.py,sha256=mw3c5jy_BWvNigUKNjIWMpReOjxFDblzOcWtsIkcls4,7907
+libinephany/observations/observation_utils.py,sha256=ejQ-hzKq_MX7A0304KypScmzloReNrH8dmcgonoRl4Q,16266
+libinephany/observations/observer_pipeline.py,sha256=_xA4vrijhG8-9MCtGXnKAEmpd6q0nKVpJgY_qSbypIA,12979
+libinephany/observations/pipeline_coordinator.py,sha256=mLfaHhkXVhMp9w5jWIAL3jPyauCM-795qOzyqwGOSdw,7932
 libinephany/observations/statistic_manager.py,sha256=LLg1zSxnJr2oQQepYla3qoUuRy10rsthr9jta4wEbnc,8956
 libinephany/observations/statistic_trackers.py,sha256=06NjCy1MI865oU0KB5f-wQE3b2RvYawOOWxNJx4rFpw,32939
 libinephany/observations/observers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-libinephany/observations/observers/base_observers.py,sha256=RkG5SW0b6Ooy0_oscRHxyB_YFNP7k8fxu37jBZElxIM,15418
+libinephany/observations/observers/base_observers.py,sha256=Tkk2AvQ6mRY6fdhhxHQWohA0xSHGdPqxul1C7C7Frj4,15924
 libinephany/observations/observers/local_observers.py,sha256=7azTW227-rG_QJR5a0StfE0O4Ca1boMV9nrCphnhWik,40344
-libinephany/observations/observers/observer_containers.py,sha256=Inz4vkqaXsyj09EJYaWWx1eOIuzmOjbiul5wRL5Gm5Y,9274
+libinephany/observations/observers/observer_containers.py,sha256=VNyqGgxYJ4r49Msp_kk-POgicb-_5w54twuT1qfNdxw,9562
 libinephany/observations/observers/global_observers/__init__.py,sha256=lQO-nq7hILu4F3ddFXcCR-ghfv0dzEA9nAYxZta7rxk,2306
 libinephany/observations/observers/global_observers/base_classes.py,sha256=CCkRx86Lll3gFzfqervP0jKdzNFKkKU7tEBh8ic1Yrc,8249
 libinephany/observations/observers/global_observers/constants.py,sha256=olXYxh353Th6hyhfk85kHxAWPeaDpuPkcz_awFvEz6c,1054
@@ -29,17 +29,17 @@ libinephany/pydantic_models/configs/outer_model_config.py,sha256=GQ0QBSC2Xht8x8X
 libinephany/pydantic_models/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/pydantic_models/schemas/agent_info.py,sha256=me5gDxvZjP9TNK588mpUvxiiJrPDqy3Z7ZHRzryAYTs,2628
 libinephany/pydantic_models/schemas/inner_task_profile.py,sha256=Xu0tQmhGwV043tTamFiHekuE1RRXhhrUrGbtymjXo7g,11722
-libinephany/pydantic_models/schemas/observation_models.py,sha256=lOLlCAFemDJh9Ml3hublncC3MwkKVQcz5PWTDMIYOEU,2091
+libinephany/pydantic_models/schemas/observation_models.py,sha256=MLhxqDet9Yol1D5mkQGQsQT23sm37AStRLnPc4sgcZc,2110
 libinephany/pydantic_models/schemas/request_schemas.py,sha256=VED8eAUvBofxeAx9gWU8DyCZOTVD3QsHRq-TO7kyOqk,1260
 libinephany/pydantic_models/schemas/response_schemas.py,sha256=SKFuasdjX5aH_I0vT3SwnpwhyMf9cNPB1ZpDeAGgoO8,2158
-libinephany/pydantic_models/schemas/tensor_statistics.py,sha256=Z-x-Fi_Dm0pLoHI88DnJO1krY671o0zbGRzx-gXPtVY,7534
+libinephany/pydantic_models/schemas/tensor_statistics.py,sha256=ZrBDiVy8Pt-Bw5RU3ePfjyFjP-jjC4_KsMmZy-Tjb1s,8115
 libinephany/pydantic_models/states/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/pydantic_models/states/hyperparameter_states.py,sha256=qQqnYyKR5ucENb_Zyk0x71_zpgUtG_rOzbOcE0kTrkQ,33478
 libinephany/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/utils/agent_utils.py,sha256=_2w1AY5Y4mQ5hes_Rq014VhZXOtIOn-W92mZgeixv3g,2658
 libinephany/utils/asyncio_worker.py,sha256=Ew23zKIbG1zwyCudcyiObMrw4G0f3p2QXzZfM4mePqI,2751
 libinephany/utils/backend_statuses.py,sha256=ZbpBPbz0qKmeqxyGGN_ePTrQ7Wrxh7KM6W26UDbPXtQ,644
-libinephany/utils/constants.py,sha256=Qh8iz5o1R4UDVVCB69jOQPX2SLWRCncpb_2yTHpFSbY,2259
+libinephany/utils/constants.py,sha256=q4R_DjFEvMhV4TKN0pswEr9YIpFTGzZeNGB-fTNttdM,2309
 libinephany/utils/directory_utils.py,sha256=408unVeE_5_Hm-ZYZuxc9sdvfuU0CgYELX7EzPlPieo,1217
 libinephany/utils/dropout_utils.py,sha256=X43yCW7Dh1cC5sNnivgS5j1fn871K_RCvxCBTT0YHKg,3392
 libinephany/utils/enums.py,sha256=6_6k_1I2BwYTIfquUOsoaQT5fkhMXUWtwCxLoTYuFyU,2906
@@ -57,8 +57,8 @@ libinephany/utils/typing.py,sha256=rGbaPO3MaUndsWiC_wHzReD_TOLYqb43i01pKN-j7Xs,6
 libinephany/web_apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/web_apps/error_logger.py,sha256=gAQIaqerqP4ornXZwFF1cghjnd2mMZEt3aVrTuUCr34,16653
 libinephany/web_apps/web_app_utils.py,sha256=qiq_lasPipgN1RgRudPJc342kYci8O_4RqppxmIX8NY,4095
-libinephany-0.16.5.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
-libinephany-0.16.5.dist-info/METADATA,sha256=-knjy_bQ-UVQ9IUTYPN6tG7dBeWUStDX1wGQFlAEoyo,8390
-libinephany-0.16.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-libinephany-0.16.5.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
-libinephany-0.16.5.dist-info/RECORD,,
+libinephany-0.18.0.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
+libinephany-0.18.0.dist-info/METADATA,sha256=WTx51KP-dxUEpT5njeRj4LgnVuw94OO9zxj49FgoUuA,8390
+libinephany-0.18.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+libinephany-0.18.0.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
+libinephany-0.18.0.dist-info/RECORD,,