libinephany 0.14.0__tar.gz → 0.15.0__tar.gz

libinephany-0.15.0/CODE_VERSION.cfg

@@ -0,0 +1 @@
+0.15.0

{libinephany-0.14.0/libinephany.egg-info → libinephany-0.15.0}/PKG-INFO

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

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/pydantic_models/configs/hyperparameter_configs.py

@@ -4,7 +4,7 @@
 #
 # ======================================================================================================================
 
-from typing import Any
+from typing import Any, cast
 
 from pydantic import BaseModel, ConfigDict, ValidationError, field_serializer, field_validator, model_validator
 
@@ -232,6 +232,23 @@ class BatchSizeHParamConfig(HParamConfig):
     sample_discrete_values: list[float | int] | None = None
 
 
+class GradientAccumulationHParamConfig(HParamConfig):
+    max_hparam_value: float | int = 64
+    min_hparam_value: float | int = 1
+    hparam_dtype: type[float | int] = int
+    initial_value: int = 1
+    initial_delta: float = 0.0
+    scale: float = 1.0
+
+    sampler: str = "DiscreteRangeSampler"
+    sample_initial_values: bool = False
+    sample_lower_bound: int = 1
+    sample_upper_bound: int = 64
+    sample_step: int = 1
+    sample_discrete_values: list[float | int] | None = None
+    force_limit: float | int = 64
+
+
 class EpochsHParamConfig(HParamConfig):
     max_hparam_value: float | int = 16
     min_hparam_value: float | int = 1
@@ -289,6 +306,7 @@ class HParamConfigs(BaseModel):
     sgd_momentum_config: HParamConfig = SGDMomentumHParamConfig()
 
     batch_size_config: HParamConfig = BatchSizeHParamConfig()
+    gradient_accumulation_config: GradientAccumulationHParamConfig = GradientAccumulationHParamConfig()
     epochs_config: HParamConfig = EpochsHParamConfig()
     token_config: HParamConfig = TokensHParamConfig()
     samples_config: HParamConfig = SamplesHParamConfig()
@@ -351,6 +369,9 @@ class HParamConfigs(BaseModel):
             case AgentTypes.BatchSize:
                 self.batch_size_config = hparam_config
 
+            case AgentTypes.GradientAccumulationAgent:
+                self.gradient_accumulation_config = cast(GradientAccumulationHParamConfig, hparam_config)
+
             case AgentTypes.Epochs:
                 self.epochs_config = hparam_config
 
@@ -400,6 +421,9 @@ class HParamConfigs(BaseModel):
             case AgentTypes.BatchSize:
                 return self.batch_size_config
 
+            case AgentTypes.GradientAccumulationAgent:
+                return self.gradient_accumulation_config
+
             case AgentTypes.Epochs:
                 return self.epochs_config
 

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/pydantic_models/schemas/inner_task_profile.py

@@ -24,6 +24,7 @@ class InnerTaskProfile(BaseModel):
     number_of_layers: int
     observation_space_sizes: dict[str, int]
     action_space_sizes: dict[str, int]
+    number_of_parameters: int
     vram_usage: float
     idle_vram_usage: float
 
@@ -139,6 +140,40 @@ class InnerTaskProfiles(BaseModel):
 
         return sum(self.compiled_action_sizes.values())
 
+    @property
+    def max_total_observation_size(self) -> int:
+        """
+        :return: The summed observation size of all agents with the task that has the most layers.
+        """
+
+        if not self.profiles:
+            raise ValueError(
+                "No profiles to calculate max total observation size. Ensure profiles have been "
+                "added before executing the training loop"
+            )
+
+        largest_task_name = max(self.profiles, key=lambda k: self.profiles[k].number_of_layers)
+        largest_task = self.profiles[largest_task_name]
+
+        return sum(largest_task.observation_space_sizes.values())
+
+    @property
+    def max_total_action_size(self) -> int:
+        """
+        :return: The summed action size of all agents with the task that has the most layers.
+        """
+
+        if not self.profiles:
+            raise ValueError(
+                "No profiles to calculate max total action size. Ensure profiles have been "
+                "added before executing the training loop"
+            )
+
+        largest_task_name = max(self.profiles, key=lambda k: self.profiles[k].number_of_layers)
+        largest_task = self.profiles[largest_task_name]
+
+        return sum(largest_task.action_space_sizes.values())
+
     @staticmethod
     def _compile_gym_space_sizes(spaces: dict[str, dict[str, int]]) -> dict[str, int]:
         """
@@ -206,6 +241,7 @@ class InnerTaskProfiles(BaseModel):
         number_of_layers: int,
         observation_space_sizes: dict[str, int],
         action_space_sizes: dict[str, int],
+        number_of_parameters: int,
         vram_usage: float,
         idle_vram_usage: float,
     ) -> None:
@@ -226,6 +262,7 @@ class InnerTaskProfiles(BaseModel):
             number_of_layers=number_of_layers,
             observation_space_sizes=observation_space_sizes,
             action_space_sizes=action_space_sizes,
+            number_of_parameters=number_of_parameters,
             vram_usage=vram_usage,
             idle_vram_usage=idle_vram_usage,
         )

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/pydantic_models/states/hyperparameter_states.py

@@ -20,6 +20,7 @@ from libinephany.utils.constants import (
     DROPOUT,
     EPOCHS,
     GRAD_NORM_CLIP,
+    GRADIENT_ACCUMULATION,
     LEARNING_RATE,
     SAMPLES,
     SGD_MOMENTUM,
@@ -60,6 +61,7 @@ class UpdateCallbacks(BaseModel):
     sgd_momentum: Callable[..., None]
 
     batch_size: Callable[..., None] | None
+    gradient_accumulation: Callable[..., None] | None
     epochs: Callable[..., None] | None
 
     def __getitem__(self, item: str) -> Callable[..., None] | None:
@@ -457,6 +459,7 @@ class ParameterGroupHParams(HyperparameterContainer):
 class GlobalHParams(HyperparameterContainer):
 
     batch_size: Hyperparameter
+    gradient_accumulation: Hyperparameter
     epochs: Hyperparameter
     tokens: Hyperparameter
     samples: Hyperparameter
@@ -550,6 +553,14 @@ class HyperparameterStates(BaseModel):
         """
         return self.global_hparams.batch_size
 
+    @computed_field  # type: ignore[misc]
+    @property
+    def gradient_accumulation(self) -> Hyperparameter:
+        """
+        :return: The gradient accumulation steps of the inner model.
+        """
+        return self.global_hparams.gradient_accumulation
+
     @computed_field  # type: ignore[misc]
     @property
     def epochs(self) -> Hyperparameter:
@@ -676,6 +687,7 @@ class HyperparameterStates(BaseModel):
 
         return {
             BATCH_SIZE: hparam_configs.batch_size_config,
+            GRADIENT_ACCUMULATION: hparam_configs.gradient_accumulation_config,
             EPOCHS: hparam_configs.epochs_config,
             TOKENS: hparam_configs.token_config,
             SAMPLES: hparam_configs.samples_config,

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/utils/constants.py

@@ -21,6 +21,7 @@ ADAM_BETA_TWO = "adam_beta_two"
 ADAM_EPS = "adam_eps"
 SGD_MOMENTUM = "sgd_momentum"
 BATCH_SIZE = "batch_size"
+GRADIENT_ACCUMULATION = "gradient_accumulation"
 EPOCHS = "epochs"
 TOKENS = "tokens"
 SAMPLES = "samples"
@@ -41,6 +42,7 @@ AGENT_PREFIX_EPS = "adam-eps"
 AGENT_PREFIX_SGD_MOMENTUM = "sgd-momentum"
 
 AGENT_BATCH_SIZE = "batch-size"
+AGENT_GRADIENT_ACCUMULATION = "gradient-accumulation"
 
 AGENT_BANDIT_SUFFIX = "bandit-agent"
 
@@ -53,6 +55,7 @@ AGENT_TYPES = [
     ADAM_BETA_TWO,
     ADAM_EPS,
     SGD_MOMENTUM,
+    GRADIENT_ACCUMULATION,
 ]
 SUFFIXES = [AGENT_BANDIT_SUFFIX]
 PREFIXES = [
@@ -64,6 +67,7 @@ PREFIXES = [
     AGENT_PREFIX_BETA_TWO,
     AGENT_PREFIX_EPS,
     AGENT_PREFIX_SGD_MOMENTUM,
+    AGENT_GRADIENT_ACCUMULATION,
 ]
 PREFIXES_TO_HPARAMS = {
     AGENT_PREFIX_LR: LEARNING_RATE,
@@ -74,4 +78,5 @@ PREFIXES_TO_HPARAMS = {
     AGENT_PREFIX_BETA_TWO: ADAM_BETA_TWO,
     AGENT_PREFIX_EPS: ADAM_EPS,
     AGENT_PREFIX_SGD_MOMENTUM: SGD_MOMENTUM,
+    AGENT_GRADIENT_ACCUMULATION: GRADIENT_ACCUMULATION,
 }

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/utils/enums.py

@@ -14,6 +14,7 @@ from libinephany.utils.constants import (
     DROPOUT,
     EPOCHS,
     GRAD_NORM_CLIP,
+    GRADIENT_ACCUMULATION,
     LEARNING_RATE,
     SAMPLES,
     SGD_MOMENTUM,
@@ -69,6 +70,7 @@ class AgentTypes(EnumWithIndices):
     AdamBetaTwoAgent = ADAM_BETA_TWO
     AdamEpsAgent = ADAM_EPS
     SGDMomentumAgent = SGD_MOMENTUM
+    GradientAccumulationAgent = GRADIENT_ACCUMULATION
 
     # Deprecated or Non-Agent
     BatchSize = BATCH_SIZE

{libinephany-0.14.0 → libinephany-0.15.0}/libinephany/utils/samplers.py

@@ -6,6 +6,7 @@
 
 import math
 from abc import abstractmethod
+from typing import Any
 
 import numpy as np
 
@@ -20,14 +21,14 @@ from libinephany.utils import random_seeds
 
 class Sampler:
 
-    def __init__(self, lower_bound: float | int, upper_bound: float | int, **kwargs) -> None:
+    def __init__(self, lower_bound: float | int | None, upper_bound: float | int | None, **kwargs) -> None:
         """
         :param lower_bound: Lower bound of the distribution to sample from.
         :param upper_bound: Upper bound of the distribution to sample from.
         :param kwargs: Miscellaneous keyword arguments.
         """
 
-        if upper_bound < lower_bound:
+        if upper_bound is not None and lower_bound is not None and upper_bound < lower_bound:
             upper_bound, lower_bound = lower_bound, upper_bound
 
         self.lower_bound = lower_bound
@@ -37,11 +38,11 @@ class Sampler:
         self,
         number_of_samples: int = 1,
         seed: int | None = None,
-    ) -> np.ndarray | float:
+    ) -> list[Any] | np.ndarray | float:
         """
         :param number_of_samples: Number of samples to make.
         :param seed: Random seed to use for distribution sampling.
-        :return: Array of sampled values or a single sampled value.
+        :return: List/Array of sampled values or a single sampled value.
         """
 
         if seed is not None:
@@ -49,10 +50,16 @@ class Sampler:
 
         sample = self.sample(number_of_samples=number_of_samples)
 
-        return sample.item() if sample.size == 1 else sample
+        if isinstance(sample, np.ndarray) and sample.size == 1:
+            return sample.item()
+
+        elif isinstance(sample, list) and len(sample) == 1:
+            return sample[0]
+
+        return sample
 
     @abstractmethod
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -64,7 +71,7 @@ class Sampler:
 
 class LogUniformSampler(Sampler):
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -78,7 +85,7 @@ class LogUniformSampler(Sampler):
 
 class UniformSampler(Sampler):
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -113,7 +120,7 @@ class DiscreteRangeSampler(Sampler):
         self.step = step
         self.sample_dtype = sample_dtype
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -160,7 +167,7 @@ class RoundRobinSampler(Sampler):
 
         return magnitude_list
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -187,8 +194,8 @@ class DiscreteValueSampler(Sampler):
 
     def __init__(
         self,
-        discrete_values: list[float | int],
-        sample_dtype: type[np.generic | float | int] = np.float64,
+        discrete_values: list[float | int | str],
+        sample_dtype: type[np.generic | float | int | str] = np.float64,
         **kwargs,
     ) -> None:
         """
@@ -196,12 +203,19 @@ class DiscreteValueSampler(Sampler):
         :param kwargs: Miscellaneous keyword arguments.
         """
 
-        super().__init__(lower_bound=min(discrete_values), upper_bound=max(discrete_values))
+        if sample_dtype == str and any(isinstance(value, str) for value in discrete_values):
+            lower_bound, upper_bound = None, None
+
+        else:
+            lower_bound = min(discrete_values)
+            upper_bound = max(discrete_values)
+
+        super().__init__(lower_bound=lower_bound, upper_bound=upper_bound)  # type: ignore
 
         self.discrete_values = discrete_values
         self.sample_dtype = sample_dtype
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -234,7 +248,7 @@ class RoundRobinDiscreteValueSampler(Sampler):
 
         self.sampled_elements: set[float] = set()
 
-    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray:
+    def sample(self, number_of_samples: int = 1, **kwargs) -> np.ndarray | list[Any]:
         """
         :param number_of_samples: Number of samples to make.
         :param kwargs: Miscellaneous keyword arguments.
@@ -329,7 +343,7 @@ def sample_from_discrete_range(
     return sample
 
 
-def sample_from_discrete_values(discrete_values: list[float | int], number_of_samples: int = 1) -> np.ndarray:
+def sample_from_discrete_values(discrete_values: list[float | int | str], number_of_samples: int = 1) -> np.ndarray:
     """
     :param discrete_values: List of discrete values to sample from.
     :param number_of_samples: Number of samples to make.

{libinephany-0.14.0 → libinephany-0.15.0/libinephany.egg-info}/PKG-INFO

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

libinephany-0.14.0/CODE_VERSION.cfg

@@ -1 +0,0 @@
-0.14.0