gradboard 0.1.10__tar.gz → 0.1.12__tar.gz

{gradboard-0.1.10 → gradboard-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gradboard
-Version: 0.1.10
+Version: 0.1.12
 Summary: Easily snowboard down gnarly loss gradients
 License: MIT
 Author: Nicholas Bailey

{gradboard-0.1.10 → gradboard-0.1.12}/gradboard/cycles.py

@@ -37,6 +37,28 @@ def cosine(step: int, total_steps: int) -> float:
     return round((math.cos(angle) + 1) / 2, 8)
 
 
+def semicircle(step: int, total_steps: int) -> float:
+    """
+    Get a sequence of numbers between 0 and 1 in the shape of a semi-circle with
+        diameter `total_steps'.
+    """
+    assert total_steps != 0
+    x = step / (total_steps - 0.999)
+    # x^2 + y^2 = r^2 = 1
+    # Therefore y^2 = 1 - x^2
+    # Therefore y^2 = (1 + x)(1 - x)
+    y_squared = (1 - x) * (1 + x)
+    return math.sqrt(y_squared)
+
+
+def half_semicircle(step: int, total_steps: int) -> float:
+    """
+    Get a sequence of numbers between 0 and 1 in the shape of the descending
+        half of a cosine wave with wavelength 2*`total_steps`.
+    """
+    return semicircle(step, (total_steps * 2) - 1)
+
+
 def half_cosine(step: int, total_steps: int) -> float:
     """
     Get a sequence of numbers between 0 and 1 in the shape of the descending
@@ -112,19 +134,7 @@ class Cycle:
 
         self.reflect = reflect
 
-        if callable(generating_function):
-            self._generating_function = generating_function
-        elif generating_function == "ascent":
-            self._generating_function = ascent
-        elif generating_function == "triangle":
-            self._generating_function = triangle
-        elif generating_function == "cosine":
-            self._generating_function = cosine
-        elif generating_function == "half_cosine":
-            self._generating_function = half_cosine
-        elif generating_function == "half_cycloid":
-            self._generating_function = half_cycloid
-        else:
+        if not callable(generating_function):
             raise NotImplementedError(
                 "`generating_function` must be a callable object or one of "
                 '"ascent", "triangle", "cosine", "half_cosine" or "half_cycloid"'
@@ -221,7 +231,12 @@ class Cycle:
 
 
 class CycleProduct(Cycle):
-    def __init__(self, cycles: List[Cycle], reflect=False):
+    def __init__(self, cycles: List[Cycle], reflect=False, normalise: bool = False):
+        """
+        Args:
+            normalise: if true, the square root of the product is returned (i.e.
+                the geometric mean of the two cycles that were multiplied together)
+        """
         main_training_examples = cycles[0].training_examples
         main_batch_size = cycles[0].batch_size
 
@@ -230,11 +245,14 @@ class CycleProduct(Cycle):
 
         self.cycles = cycles
         self.reflect = reflect
+        self.normalise = normalise
 
         def generating_function(step: int, total_steps: int) -> float:
             output = self.cycles[0](step)
             for c in self.cycles[1:]:
                 output *= c(step % c.total_steps)
+            if self.normalise:
+                output = math.sqrt(output)
             return output
 
         super().__init__(

{gradboard-0.1.10 → gradboard-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gradboard"
-version = "0.1.10"
+version = "0.1.12"
 description = "Easily snowboard down gnarly loss gradients"
 authors = [
     {name = "Nicholas Bailey"}