libinephany 1.1.4__py3-none-any.whl → 1.1.6__py3-none-any.whl

libinephany/observations/observers/base_observers.py

@@ -261,7 +261,8 @@ class Observer(ABC):
                 f"{self.invalid_observation_threshold})! Ratio: {inf_ratio:.2%} ({inf_count}/{len(observations)})"
             )
             validate = False
-        logger.debug(
+
+        logger.trace(
             f'Observer: {self.__class__.__name__} observation validation {"passed" if validate else "failed"}!'
         )
 

libinephany/observations/observers/global_observers/__init__.py

@@ -47,7 +47,7 @@ from .model_observers import (
     NumberOfLayers,
     NumberOfParameters,
 )
-from .progress_observers import EpochsCompleted, ProgressAtEachCheckpoint, TrainingProgress
+from .progress_observers import EpochsCompleted, ProgressAtEachCheckpoint, StagnationObserver, TrainingProgress
 
 __all__ = [
     InitialHyperparameters.__name__,
@@ -84,4 +84,5 @@ __all__ = [
     CosineSimilarityObserverOfGradientAndMomentum.__name__,
     CosineSimilarityObserverOfGradientAndUpdate.__name__,
     CosineSimilarityOfGradientAndParameter.__name__,
+    StagnationObserver.__name__,
 ]

libinephany/observations/observers/global_observers/progress_observers.py

@@ -3,7 +3,7 @@
 # IMPORTS
 #
 # ======================================================================================================================
-
+import math
 from typing import Any
 
 from libinephany.observations.observation_utils import StatisticStorageTypes
@@ -146,3 +146,76 @@ class ProgressAtEachCheckpoint(LHOPTCheckpointBaseObserver):
             return current_progress
         else:
             return self.last_value
+
+
+class StagnationObserver(GlobalObserver):
+
+    def __init__(self, stagnation_threshold: float = 0.0, log_transform: bool = True, **kwargs):
+        """
+        :param stagnation_threshold: The loss improvement threshold. Default is 0.0. This is the amount the validation
+        loss must improve by over the best validation loss to reset the stagnation counter.
+        We assume that improvement means loss decreases regardless of the sign of the loss, which means the best loss is
+        negative infinity.
+        :param log_transform: Whether to log transform the stagnation counter. Default is True.
+        :param kwargs: Miscellaneous keyword arguments.
+        """
+        super().__init__(**kwargs)
+        self.best_validation_loss: float | None = None
+        self.stagnation_counter: int = 0
+        self.stagnation_threshold = stagnation_threshold
+        self.log_transform = log_transform
+
+    @property
+    def can_standardize(self) -> bool:
+        """
+        :return: Whether the observation can be standardized.
+        """
+
+        return False
+
+    def _get_observation_format(self) -> StatisticStorageTypes:
+        """
+        :return: Format the observation returns data in. Must be one of the enum attributes in the StatisticStorageTypes
+        enumeration class.
+        """
+
+        return StatisticStorageTypes.FLOAT
+
+    def _observe(
+        self,
+        observation_inputs: ObservationInputs,
+        hyperparameter_states: HyperparameterStates,
+        tracked_statistics: dict[str, dict[str, float | TensorStatistics]],
+        action_taken: float | int | None,
+    ) -> float | int | list[int | float] | TensorStatistics:
+        """
+        :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: Single float/int, list of floats/ints or TensorStatistics model to add to the observation vector.
+        """
+        # Validate input values, if loss is invalid, increment stagnation counter
+        if math.isnan(observation_inputs.validation_loss) or math.isinf(observation_inputs.validation_loss):
+            self.stagnation_counter += 1
+        else:
+            if self.best_validation_loss is None:
+                self.best_validation_loss = observation_inputs.validation_loss
+                self.stagnation_counter = 0
+            else:
+                improvement = self.best_validation_loss - observation_inputs.validation_loss
+                if improvement > self.stagnation_threshold:
+                    self.best_validation_loss = observation_inputs.validation_loss
+                    self.stagnation_counter = 0
+                else:
+                    self.stagnation_counter += 1
+        return self.stagnation_counter if not self.log_transform else math.log(self.stagnation_counter + 1)
+
+    def get_required_trackers(self) -> dict[str, dict[str, Any] | None]:
+        """
+        :return: Dictionary mapping statistic tracker class names to kwargs for the class or None if no kwargs are
+        needed.
+        """
+
+        return {}

{libinephany-1.1.4.dist-info → libinephany-1.1.6.dist-info}/METADATA

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

{libinephany-1.1.4.dist-info → libinephany-1.1.6.dist-info}/RECORD

@@ -8,17 +8,17 @@ libinephany/observations/pipeline_coordinator.py,sha256=mLfaHhkXVhMp9w5jWIAL3jPy
 libinephany/observations/statistic_manager.py,sha256=LLg1zSxnJr2oQQepYla3qoUuRy10rsthr9jta4wEbnc,8956
 libinephany/observations/statistic_trackers.py,sha256=nBxOxB9NHHr6OZylmgPpY3AXOr7kAJ0MF899YbAP_oc,48201
 libinephany/observations/observers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-libinephany/observations/observers/base_observers.py,sha256=nUgpcKGwKagH9zqdztkjcycxmLToVrq8ju0WB8zJtdk,19885
+libinephany/observations/observers/base_observers.py,sha256=THfOE4ozP_LG1UfsiuJkH6dhqp4VOpXY4NmpVlAa-kY,19886
 libinephany/observations/observers/local_observers.py,sha256=HvOQhVEANQJjAl6Ln_YuP0-fNt_Xkh8ixlkb-A5JqDM,46318
 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/__init__.py,sha256=H8WHtWyBmjBQkaoy6fxkgYCkr-FEKJXgIRpVnw_ThZU,3071
 libinephany/observations/observers/global_observers/base_classes.py,sha256=Q7OblhmKscypTs9JBepSQwo6ljjOdPKTU9kbpuhq_W4,7800
 libinephany/observations/observers/global_observers/constants.py,sha256=TDQM_sGU8Swze794oB4TBaXFjSddt0OBhYPVhrXQ9Ko,1654
 libinephany/observations/observers/global_observers/gradient_observers.py,sha256=j9uX7043ic06W6vb6vDt_PH2a5WtLFCdKQZ1JQGT24Q,19531
 libinephany/observations/observers/global_observers/hyperparameter_observers.py,sha256=5Av8FgwWBJtcn4gpDzPdOTlKOOYy2lVEHS_gt5Sz7xo,15334
 libinephany/observations/observers/global_observers/loss_observers.py,sha256=Kf943FiuYWuWvjmhgmp3TGyIQoZ27ZKJcxfTBwXS-gA,17761
 libinephany/observations/observers/global_observers/model_observers.py,sha256=SGWXrmTdgp0kHvEvDSF7d3v1FEcK1sQDMPLQ8Wy3qv4,29306
-libinephany/observations/observers/global_observers/progress_observers.py,sha256=ypLk1_POAjA8V8rAaQ0B6Qh8m_04s9PAoXsw1KxVrLg,5872
+libinephany/observations/observers/global_observers/progress_observers.py,sha256=vJwue9tY6XjQKU_79ZAZMnC4HZjR8Y-AGyZpgEKiDbU,9284
 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
@@ -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=QpspO726Uoyyr6lBEEb3Q9XqhVOXUM4AaYE7vbnk31c,18153
 libinephany/web_apps/web_app_utils.py,sha256=qiq_lasPipgN1RgRudPJc342kYci8O_4RqppxmIX8NY,4095
-libinephany-1.1.4.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
-libinephany-1.1.4.dist-info/METADATA,sha256=jRCMmu7yAURPjD2ZRJnKxCMpZD9son6Xx4mQ1HBbWzc,8389
-libinephany-1.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-libinephany-1.1.4.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
-libinephany-1.1.4.dist-info/RECORD,,
+libinephany-1.1.6.dist-info/licenses/LICENSE,sha256=pogfDoMBP07ehIOvWymuWIar8pg2YLUhqOHsJQU3wdc,9250
+libinephany-1.1.6.dist-info/METADATA,sha256=js8dpqAYAwo1UTFR7sOReZMQ25IWrX4EucCdDfEQFgc,8389
+libinephany-1.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+libinephany-1.1.6.dist-info/top_level.txt,sha256=bYAOXQdJgIoLkO2Ui0kxe7pSYegS_e38u0dMscd7COQ,12
+libinephany-1.1.6.dist-info/RECORD,,