libinephany 0.18.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

libinephany/pydantic_models/schemas/tensor_statistics.py

@@ -13,7 +13,7 @@ from pydantic import BaseModel
 #
 # ======================================================================================================================
 
-STRIP_SUFFIX = "_"
+FIELD_SUFFIX = "_"
 
 # ======================================================================================================================
 #
@@ -164,28 +164,38 @@ class TensorStatistics(BaseModel):
         return tensor[random_indices]
 
     @classmethod
-    def filter_skip_statistics(cls, skip_statistics: list[str] | None) -> list[str]:
+    def filter_include_statistics(cls, include_statistics: list[str]) -> list[str]:
         """
-        :param skip_statistics: Names of the fields in the model to not include in returned observations.
-        :return: Empty list if skip_statistics was None or skip_statistics filtered to include only the names of fields
-        present in this pydantic model.
+        :param include_statistics: Names of the fields in the model to include in returned observations.
+        :return: List of fields from the given include_statistics list that are present in this pydantic model.
+        :raises ValueError: If no statistics to include are given.
         """
 
-        return (
-            [skip_stat for skip_stat in skip_statistics if skip_stat in cls.model_fields.keys()]
-            if skip_statistics is not None
-            else []
-        )
+        filtered_include_statistics: list[str] = []
+
+        for include_stat in include_statistics:
+            with_suffix = include_stat + FIELD_SUFFIX if not include_stat.endswith(FIELD_SUFFIX) else include_stat
+
+            if with_suffix in cls.model_fields.keys():
+                filtered_include_statistics.append(with_suffix)
+
+        if not filtered_include_statistics:
+            raise ValueError(f"No statistics to include given to {cls.__name__}!")
+
+        return filtered_include_statistics
 
     @classmethod
     def build(
-        cls, tensor: torch.Tensor, sample_percentage: float = 0.01, skip_statistics: list[str] | None = None
+        cls,
+        tensor: torch.Tensor,
+        include_statistics: list[str],
+        sample_percentage: float = 0.01,
     ) -> "TensorStatistics":
         """
         :param tensor: Tensor to compute and store statistics of.
+        :param include_statistics: If the observation uses the TensorStatistic model to return observations, names of the
+        fields in the model to include in returned observations.
         :param sample_percentage: Percentage of the given tensor to randomly sample and compute statistics from.
-        :param skip_statistics: If the observation uses the TensorStatistic model to return observations, names of the
-        fields in the model to not include in returned observations.
         :return: Constructed tensor statistics.
         """
 
@@ -193,12 +203,10 @@ class TensorStatistics(BaseModel):
         downsampled_tensor = cls.downsample_tensor(tensor=tensor, sample_percentage=sample_percentage)
 
         for field, field_value in stats.model_dump().items():
-            name = field[:-1] if field.endswith("_") else field
-
-            if skip_statistics is not None and name in skip_statistics:
-                continue
+            name = field[:-1] if field.endswith(FIELD_SUFFIX) else field
 
-            setattr(stats, name, downsampled_tensor)
+            if name in include_statistics:
+                setattr(stats, name, downsampled_tensor)
 
         return stats
 
@@ -219,28 +227,21 @@ class TensorStatistics(BaseModel):
             inter_quartile_range_=tensor[6],
         )
 
-    def to_list(self, skip_statistics: list[str] | None) -> list[float]:
+    def to_list(self, include_statistics: list[str]) -> list[float]:
         """
-        :param skip_statistics: None or a list of field names to skip from adding to the returned list.
+        :param include_statistics: List of field names to include in the returned list.
         :return: List of field values.
         """
 
-        if skip_statistics is None:
-            skip_statistics = []
-
-        if not all(skip_stat in self.model_fields.keys() for skip_stat in skip_statistics):
-            raise ValueError(
-                f"One or more skip statistic keys do not exist in TensorStatistics. Valid Skip Keys: "
-                f"{list(self.model_fields.keys())} Given Skip Keys: {skip_statistics}"
-            )
+        filtered_includes = self.filter_include_statistics(include_statistics=include_statistics)
 
         as_list = []
 
         for field, field_value in self.model_dump().items():
-            if field in skip_statistics:
-                continue
+            without_suffix = field[:-1]
 
-            as_list.append(field_value)
+            if field in filtered_includes or without_suffix in filtered_includes:
+                as_list.append(field_value)
 
         return as_list
 
@@ -267,6 +268,6 @@ class TensorStatistics(BaseModel):
         """
 
         return {
-            field[:-1] if field.endswith(STRIP_SUFFIX) else field: field_value
+            field[:-1] if field.endswith(FIELD_SUFFIX) else field: field_value
             for field, field_value in self.model_dump().items()
         }

libinephany/pydantic_models/states/hyperparameter_states.py

@@ -295,52 +295,52 @@ class HyperparameterContainer(BaseModel):
             f"{self.get_hyperparameters()}."
         )
 
-    def get_initial_internal_values(self, skip_hparams: list[str] | None = None) -> dict[str, float | int | None]:
+    def get_initial_internal_values(self, include_hparams: list[str] | None = None) -> dict[str, float | int | None]:
         """
-        :param skip_hparams: Names of the hyperparameters to not include in the initial values vector returned by
-        this observation.
+        :param include_hparams: Names of the hyperparameters to include in the hyperparameter name to initial internal
+        value mapping.
         :return: Dictionary mapping hyperparameter names to their current values for this parameter group.
         """
 
-        if skip_hparams is None:
-            skip_hparams = []
+        if include_hparams is None:
+            include_hparams = list(self.model_fields.keys())
 
         return {
             field_name: field_value.initial_internal_value
             for field_name, field_value in self.__dict__.items()
-            if isinstance(field_value, Hyperparameter) and field_name not in skip_hparams
+            if isinstance(field_value, Hyperparameter) and field_name in include_hparams
         }
 
-    def get_current_internal_values(self, skip_hparams: list[str] | None = None) -> dict[str, float | int | None]:
+    def get_current_internal_values(self, include_hparams: list[str] | None = None) -> dict[str, float | int | None]:
         """
-        :param skip_hparams: Names of the hyperparameters to not include in the current values vector returned by
-        this observation.
+        :param include_hparams: Names of the hyperparameters to include in the hyperparameter name to current internal
+        value mapping.
         :return: Dictionary mapping hyperparameter names to their current values for this parameter group.
         """
 
-        if skip_hparams is None:
-            skip_hparams = []
+        if include_hparams is None:
+            include_hparams = list(self.model_fields.keys())
 
         return {
             field_name: field_value.current_internal_value
             for field_name, field_value in self.__dict__.items()
-            if isinstance(field_value, Hyperparameter) and field_name not in skip_hparams
+            if isinstance(field_value, Hyperparameter) and field_name in include_hparams
         }
 
-    def get_current_deltas(self, skip_hparams: list[str] | None = None) -> dict[str, float | int | None]:
+    def get_current_deltas(self, include_hparams: list[str] | None = None) -> dict[str, float | int | None]:
         """
-        :param skip_hparams: Names of the hyperparameters to not include in the current deltas vector returned by
-        this observation.
+        :param include_hparams: Names of the hyperparameters to include in the hyperparameter name to current delta
+        mapping.
         :return: Dictionary mapping hyperparameter names to their current deltas for this parameter group.
         """
 
-        if skip_hparams is None:
-            skip_hparams = []
+        if include_hparams is None:
+            include_hparams = list(self.model_fields.keys())
 
         return {
             field_name: field_value.current_delta
             for field_name, field_value in self.__dict__.items()
-            if isinstance(field_value, Hyperparameter) and field_name not in skip_hparams
+            if isinstance(field_value, Hyperparameter) and field_name in include_hparams
         }
 
     def set_internal_values(self, internal_values: dict[str, float | int | None]) -> None:
@@ -440,19 +440,21 @@ class ParameterGroupHParams(HyperparameterContainer):
         )
 
     def get_hyperparameter_transform_types(
-        self, skip_hparams: list[str] | None = None
+        self, include_hparams: list[str] | None = None
     ) -> dict[str, HyperparameterTransformType]:
         """
+        :param include_hparams: Names of the hyperparameters to include in the hyperparameter name to transform type
+        mapping.
         :return: Dictionary mapping hyperparameter names to their transform type for this parameter group.
         """
 
-        if skip_hparams is None:
-            skip_hparams = []
+        if include_hparams is None:
+            include_hparams = list(self.model_fields.keys())
 
         return {
             field_name: field_value.transform_type
             for field_name, field_value in self.__dict__.items()
-            if isinstance(field_value, Hyperparameter) and field_name not in skip_hparams
+            if isinstance(field_value, Hyperparameter) and field_name in include_hparams
         }
 
 
@@ -839,15 +841,15 @@ class HyperparameterStates(BaseModel):
         for parameter_group_hparams in self.parameter_group_hparams.values():
             parameter_group_hparams.set_to_initial_values()
 
-    def get_initial_internal_values(self, skip_hparams: list[str] | None = None) -> dict[str, float | int | None]:
+    def get_initial_internal_values(self, include_hparams: list[str] | None = None) -> dict[str, float | int | None]:
         """
-        :param skip_hparams: Hyperparameters to ignore while retrieving initial values.
+        :param include_hparams: Hyperparameters to include while retrieving initial values.
         :return: Dictionary mapping hyperparameter names to their initial values at the start of training.
         """
 
         initial_internal_values = {
-            **self.global_hparams.get_initial_internal_values(skip_hparams),
-            **next(iter(self.parameter_group_hparams.values())).get_initial_internal_values(skip_hparams),
+            **self.global_hparams.get_initial_internal_values(include_hparams),
+            **next(iter(self.parameter_group_hparams.values())).get_initial_internal_values(include_hparams),
         }
         initial_internal_values = {
             hparam_name: initial_internal_values.get(hparam_name, None)
@@ -856,15 +858,15 @@ class HyperparameterStates(BaseModel):
 
         return initial_internal_values
 
-    def get_current_internal_values(self, skip_hparams: list[str] | None = None) -> dict[str, float | int | None]:
+    def get_current_internal_values(self, include_hparams: list[str] | None = None) -> dict[str, float | int | None]:
         """
-        :param skip_hparams: Hyperparameters to ignore while retrieving current values.
+        :param include_hparams: Hyperparameters to include while retrieving current values.
         :return: Dictionary mapping hyperparameter names to their current values during training.
         """
 
         current_internal_values = {
-            **self.global_hparams.get_current_internal_values(skip_hparams),
-            **next(iter(self.parameter_group_hparams.values())).get_current_internal_values(skip_hparams),
+            **self.global_hparams.get_current_internal_values(include_hparams),
+            **next(iter(self.parameter_group_hparams.values())).get_current_internal_values(include_hparams),
         }
         current_internal_values = {
             hparam_name: current_internal_values.get(hparam_name, None)

{libinephany-0.18.1.dist-info → libinephany-1.0.0.dist-info}/METADATA

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

{libinephany-0.18.1.dist-info → libinephany-1.0.0.dist-info}/RECORD

@@ -2,23 +2,23 @@ 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=ejQ-hzKq_MX7A0304KypScmzloReNrH8dmcgonoRl4Q,16266
+libinephany/observations/observation_utils.py,sha256=JSNJYEi2d-VQ0ZovfHrn28RDv41u-a6M-W4ZT8UUyhI,17279
 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/statistic_trackers.py,sha256=3LHvBXQ977-9ZW-KE9UohDeOayZdqQ5UQMTt0kuea40,47574
 libinephany/observations/observers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-libinephany/observations/observers/base_observers.py,sha256=Tkk2AvQ6mRY6fdhhxHQWohA0xSHGdPqxul1C7C7Frj4,15924
-libinephany/observations/observers/local_observers.py,sha256=7azTW227-rG_QJR5a0StfE0O4Ca1boMV9nrCphnhWik,40344
+libinephany/observations/observers/base_observers.py,sha256=9YI_jkivoCjyPtNSn3VnPADF1VqwGdHPkgi1kDzed3Y,16516
+libinephany/observations/observers/local_observers.py,sha256=yBXmuCaDZotJPmBZKdrPfGYtVO-CCvT5ZS0KvROOcE4,45657
 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/__init__.py,sha256=87WHRPYmL0tVsaTKUd91pwEpCZtHPSKRQoba2VQjswA,3018
 libinephany/observations/observers/global_observers/base_classes.py,sha256=CCkRx86Lll3gFzfqervP0jKdzNFKkKU7tEBh8ic1Yrc,8249
-libinephany/observations/observers/global_observers/constants.py,sha256=olXYxh353Th6hyhfk85kHxAWPeaDpuPkcz_awFvEz6c,1054
-libinephany/observations/observers/global_observers/gradient_observers.py,sha256=z2ow6zmTr7ujeaYyh5qGRE1woIt_yc2uxAaie7zgxqc,8398
-libinephany/observations/observers/global_observers/hyperparameter_observers.py,sha256=soGWoYpO5rqUQU0p4pr6QVjBvVg2odK71mVkxV38Ras,14838
+libinephany/observations/observers/global_observers/constants.py,sha256=C_PwYhKxatJxNe5Jzb1tpoiRXAxxPrGkcdQBMQD8msY,1139
+libinephany/observations/observers/global_observers/gradient_observers.py,sha256=ZeujBhKeq8adw_J13omurjZnfloiadMYkiPuXYUZ8BU,20972
+libinephany/observations/observers/global_observers/hyperparameter_observers.py,sha256=o035-nSfjj7dy7Pz1IxpAqvU3tYQraxQd8Pttknxa6A,15034
 libinephany/observations/observers/global_observers/loss_observers.py,sha256=FlSuJqAJIXcAS_ypdZna6xxz89glI23A6D00sDn7ZLU,18508
-libinephany/observations/observers/global_observers/model_observers.py,sha256=bJIEdq5wWkLrw-MNllCe36FE4aMLbC4RoR1-wOOHMxc,19537
-libinephany/observations/observers/global_observers/progress_observers.py,sha256=m62jUiwPaOUzYG1h7Vg6znj_jK9699lDhg4AhK212s8,5615
+libinephany/observations/observers/global_observers/model_observers.py,sha256=HVNHnqk2uuXkmP8y3SL-IQ0AYArfXc7b-wckv9X7qbM,28457
+libinephany/observations/observers/global_observers/progress_observers.py,sha256=ypLk1_POAjA8V8rAaQ0B6Qh8m_04s9PAoXsw1KxVrLg,5872
 libinephany/observations/post_processors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libinephany/observations/post_processors/postprocessors.py,sha256=43_e5UaDPr2KbAvqc_w3wLqnlm7bgRjqgCtyQ95-8cM,5913
 libinephany/pydantic_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -32,9 +32,9 @@ libinephany/pydantic_models/schemas/inner_task_profile.py,sha256=Xu0tQmhGwV043tT
 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=ZrBDiVy8Pt-Bw5RU3ePfjyFjP-jjC4_KsMmZy-Tjb1s,8115
+libinephany/pydantic_models/schemas/tensor_statistics.py,sha256=hWl52SxPYHFBXUwwZ9X7E1iFhuxGsPypd14hFTx91jw,8166
 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/pydantic_models/states/hyperparameter_states.py,sha256=Esi1xdrH9xOJwhpSezkfbTzbKX4O26IpN5zzkWD3Mf8,33779
 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
@@ -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.18.1.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
-libinephany-0.18.1.dist-info/METADATA,sha256=d2rH-yA7F1cVk2OnTyvdaQ6_CFey1uiY4ATbqsxH9Pg,8390
-libinephany-0.18.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-libinephany-0.18.1.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
-libinephany-0.18.1.dist-info/RECORD,,
+libinephany-1.0.0.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
+libinephany-1.0.0.dist-info/METADATA,sha256=N_0lNQBtTOt8bzKEyQhmiA_l4AkWKtMoq6GDL3FGXKI,8389
+libinephany-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+libinephany-1.0.0.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
+libinephany-1.0.0.dist-info/RECORD,,