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

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.19.0.dist-info → libinephany-1.0.0.dist-info}/METADATA

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

@@ -6,19 +6,19 @@ libinephany/observations/observation_utils.py,sha256=JSNJYEi2d-VQ0ZovfHrn28RDv41
 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=Z0JCJouVaPRUdR9o8GbD4Vm72aRREuxUIqGY8zgFUWg,53622
+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=9zWPizg6LuuembSibX67azIF12_Mr07EIzx_6d9ANVU,45290
+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=87WHRPYmL0tVsaTKUd91pwEpCZtHPSKRQoba2VQjswA,3018
 libinephany/observations/observers/global_observers/base_classes.py,sha256=CCkRx86Lll3gFzfqervP0jKdzNFKkKU7tEBh8ic1Yrc,8249
 libinephany/observations/observers/global_observers/constants.py,sha256=C_PwYhKxatJxNe5Jzb1tpoiRXAxxPrGkcdQBMQD8msY,1139
-libinephany/observations/observers/global_observers/gradient_observers.py,sha256=6L9Hw6K--vTRe0Zp4dQ9ByOLwU6p9Z8vhMYcTQVA4IU,21042
-libinephany/observations/observers/global_observers/hyperparameter_observers.py,sha256=soGWoYpO5rqUQU0p4pr6QVjBvVg2odK71mVkxV38Ras,14838
+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=xNqNWz2YUATakm_BuHXCGtGCeYodpyeupa8yxLo-TAA,28433
-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.19.0.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
-libinephany-0.19.0.dist-info/METADATA,sha256=iojcQg83wJVyPzuFssPtW_Maz0wO2JGFXCLcolBsnfQ,8390
-libinephany-0.19.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-libinephany-0.19.0.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
-libinephany-0.19.0.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,,