Restore Class Names in decay and mutators Folders for Backward Compatibility

.gitignore

@@ -29,7 +29,7 @@ tsp_test/
 
 # Virtual environments
 venvp/
-
+venv
 # Aider tool
 .aider*
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mlrose-ky"
-version = "1.0.5"
+version = "1.0.6"
 description = "MLROSe-ky: Machine Learning, Randomized Optimization and Search"
 readme = "README.md"
 requires-python = ">=3.10"

src/mlrose_ky/algorithms/decay/__init__.py

@@ -6,4 +6,4 @@
 from .arithmetic_decay import ArithmeticDecay
 from .custom_decay import CustomDecay
 from .exponential_decay import ExponentialDecay
-from .geometric_decay import GeometricDecay
+from .geometric_decay import GeometricDecay, GeomDecay

src/mlrose_ky/algorithms/decay/arithmetic_decay.py

@@ -4,7 +4,7 @@
 # License: BSD 3-clause
 
 
-class ArithmeticDecay:
+class ArithDecay:
     """
     Schedule for arithmetically decaying the temperature parameter T in a
     simulated annealing process, calculated using the formula:
@@ -36,7 +36,7 @@ class ArithmeticDecay:
 
     Examples
     --------
-    >>> schedule = ArithmeticDecay(initial_temperature=10, decay_rate=0.95, minimum_temperature=1)
+    >>> schedule = ArithDecay(initial_temperature=10, decay_rate=0.95, minimum_temperature=1)
     >>> schedule.evaluate(5)
     5.25
     """
@@ -64,7 +64,7 @@ def __repr__(self) -> str:
         return self.__str__()
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, ArithmeticDecay):
+        if not isinstance(other, ArithDecay):
             return False
         return (
             self.initial_temperature == other.initial_temperature

src/mlrose_ky/algorithms/decay/custom_decay.py

@@ -6,7 +6,7 @@
 from typing import Callable
 
 
-class CustomDecay:
+class CustomSchedule:
     """
     Class for generating a customizable temperature schedule for simulated annealing.
 
@@ -24,7 +24,7 @@ class CustomDecay:
     -------
     >>> def custom_decay_function(time: int, offset: int) -> float: return time + offset
     >>> kwargs = {'offset': 10}
-    >>> schedule = CustomDecay(custom_decay_function, **kwargs)
+    >>> schedule = CustomSchedule(custom_decay_function, **kwargs)
     >>> schedule.evaluate(5)
     15
     """
@@ -40,7 +40,7 @@ def __repr__(self) -> str:
         return self.__str__()
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, CustomDecay):
+        if not isinstance(other, CustomSchedule):
             return False
         return self.decay_function == other.decay_function and self.kwargs == other.kwargs
 

src/mlrose_ky/algorithms/decay/exponential_decay.py

@@ -6,7 +6,7 @@
 import numpy as np
 
 
-class ExponentialDecay:
+class ExpDecay:
     """
     Defines an exponential decay schedule for the temperature parameter T in simulated annealing,
     using the formula:
@@ -38,7 +38,7 @@ class ExponentialDecay:
 
     Examples
     --------
-    >>> schedule = ExponentialDecay(initial_temperature=10, decay_rate=0.05, minimum_temperature=1)
+    >>> schedule = ExpDecay(initial_temperature=10, decay_rate=0.05, minimum_temperature=1)
     >>> print(schedule.evaluate(5))
     7.788007830714049
     """
@@ -66,7 +66,7 @@ def __repr__(self) -> str:
         return self.__str__()
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, ExponentialDecay):
+        if not isinstance(other, ExpDecay):
             return False
         return (
             self.initial_temperature == other.initial_temperature

src/mlrose_ky/algorithms/decay/geometric_decay.py

@@ -4,7 +4,8 @@
 # License: BSD 3-clause
 
 
-class GeometricDecay:
+
+class GeomDecay:
     """
     Defines a geometric decay schedule for the temperature parameter T in simulated annealing,
     using the formula:
@@ -36,7 +37,7 @@ class GeometricDecay:
 
     Examples
     --------
-    >>> schedule = GeometricDecay(initial_temperature=10, decay_rate=0.95, minimum_temperature=1)
+    >>> schedule = GeomDecay(initial_temperature=10, decay_rate=0.95, minimum_temperature=1)
     >>> print(schedule.evaluate(5))
     7.737809374999998
     """
@@ -64,13 +65,11 @@ def __repr__(self) -> str:
         return self.__str__()
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, GeometricDecay):
+        if not isinstance(other, GeomDecay):
             return False
-        return (
-            self.initial_temperature == other.initial_temperature
-            and self.decay_rate == other.decay_rate
-            and self.minimum_temperature == other.minimum_temperature
-        )
+        return (self.initial_temperature == other.initial_temperature
+                and self.decay_rate == other.decay_rate
+                and self.minimum_temperature == other.minimum_temperature)
 
     def evaluate(self, time: int) -> float:
         """
@@ -86,8 +85,7 @@ def evaluate(self, time: int) -> float:
         float
             The temperature parameter at the given time, respecting the minimum temperature.
         """
-        temperature = max(self.initial_temperature * (self.decay_rate**time), self.minimum_temperature)
-        return temperature
+        return max(self.initial_temperature * (self.decay_rate ** time), self.minimum_temperature)
 
     def get_info(self, time: int | None = None, prefix: str = "") -> dict:
         """
@@ -118,3 +116,6 @@ def get_info(self, time: int | None = None, prefix: str = "") -> dict:
             info[f"{info_prefix}current_value"] = self.evaluate(time)
 
         return info
+
+
+

src/mlrose_ky/algorithms/mutators/discrete_mutator.py

@@ -9,7 +9,7 @@
 from mlrose_ky.algorithms.mutators._mutator_base import _MutatorBase
 
 
-class DiscreteGeneMutator(_MutatorBase):
+class DiscreteMutator(_MutatorBase):
     """
     A mutator class that performs discrete mutation on individual genes in a genetic algorithm.
 

src/mlrose_ky/algorithms/mutators/gene_swap_mutator.py

@@ -9,7 +9,7 @@
 from mlrose_ky.algorithms.mutators._mutator_base import _MutatorBase
 
 
-class GeneSwapMutator(_MutatorBase):
+class SwapMutator(_MutatorBase):
     """
     A mutator class that implements the 'Gene Swap' mutation strategy in genetic algorithms.
 

src/mlrose_ky/algorithms/mutators/single_gene_mutator.py

@@ -9,7 +9,7 @@
 from mlrose_ky.algorithms.mutators._mutator_base import _MutatorBase
 
 
-class SingleGeneMutator(_MutatorBase):
+class ChangeOneMutator(_MutatorBase):
     """
     A mutator class that performs the 'Change One' mutation strategy in a genetic algorithm.
 

src/mlrose_ky/algorithms/mutators/single_shift_mutator.py

@@ -9,7 +9,7 @@
 from mlrose_ky.algorithms.mutators._mutator_base import _MutatorBase
 
 
-class SingleShiftMutator(_MutatorBase):
+class ShiftOneMutator(_MutatorBase):
     """
     A mutator class that implements the 'Shift One' mutation strategy in a genetic algorithm.