Merge pull request #9 from gitongah/rename_Class

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*
 

src/mlrose_ky/__init__.py

@@ -3,16 +3,34 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
+# noinspection PyUnresolvedReferences
 from .algorithms.ga import genetic_alg
+
+# noinspection PyUnresolvedReferences
 from .algorithms.sa import simulated_annealing
+
+# noinspection PyUnresolvedReferences
 from .algorithms.hc import hill_climb
+
+# noinspection PyUnresolvedReferences
 from .algorithms.rhc import random_hill_climb
+
+# noinspection PyUnresolvedReferences
 from .algorithms.gd import gradient_descent
+
+# noinspection PyUnresolvedReferences
 from .algorithms.mimic import mimic
-from .algorithms.decay import GeometricDecay, ArithmeticDecay, ExponentialDecay, CustomDecay
+
+# noinspection PyUnresolvedReferences
+from .algorithms.decay import GeomDecay, ArithDecay, ExpDecay, CustomSchedule
+
+# noinspection PyUnresolvedReferences
 from .algorithms.crossovers import OnePointCrossover, UniformCrossover, TSPCrossover
-from .algorithms.mutators import SingleGeneMutator, DiscreteGeneMutator, GeneSwapMutator, SingleShiftMutator
 
+# noinspection PyUnresolvedReferences
+from .algorithms.mutators import ChangeOneMutator, DiscreteMutator, SwapMutator, ShiftOneMutator
+
+# noinspection PyUnresolvedReferences
 from .fitness import (
     OneMax,
     FlipFlop,
@@ -26,17 +44,29 @@
     CustomFitness,
 )
 
+# noinspection PyUnresolvedReferences
 from .neural import NeuralNetwork, LinearRegression, LogisticRegression, NNClassifier, nn_core
+
+# noinspection PyUnresolvedReferences
 from .neural.activation import identity, relu, leaky_relu, sigmoid, softmax, tanh
+
+# noinspection PyUnresolvedReferences
 from .neural.fitness import NetworkWeights
+
+# noinspection PyUnresolvedReferences
 from .neural.utils.weights import flatten_weights, unflatten_weights
 
+# noinspection PyUnresolvedReferences
 from .gridsearch import GridSearchMixin
 
+# noinspection PyUnresolvedReferences
 from .opt_probs import DiscreteOpt, ContinuousOpt, KnapsackOpt, TSPOpt, QueensOpt, FlipFlopOpt, MaxKColorOpt
 
+# noinspection PyUnresolvedReferences
 from .runners import GARunner, MIMICRunner, RHCRunner, SARunner, NNGSRunner, SKMLPRunner, build_data_filename
 
+# noinspection PyUnresolvedReferences
 from .generators import MaxKColorGenerator, QueensGenerator, FlipFlopGenerator, TSPGenerator, KnapsackGenerator, ContinuousPeaksGenerator
 
+# noinspection PyUnresolvedReferences
 from .samples import SyntheticDataGenerator, plot_synthetic_dataset

src/mlrose_ky/algorithms/__init__.py

@@ -3,15 +3,12 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
+from .crossovers import UniformCrossover, TSPCrossover, OnePointCrossover
+from .decay import ArithDecay, CustomSchedule, ExpDecay, GeomDecay
 from .ga import genetic_alg
-from .sa import simulated_annealing
-from .hc import hill_climb
-from .rhc import random_hill_climb
 from .gd import gradient_descent
+from .hc import hill_climb
 from .mimic import mimic
-
-from .crossovers import UniformCrossover, TSPCrossover, OnePointCrossover
-
-from .decay import ArithmeticDecay, CustomDecay, ExponentialDecay, GeometricDecay
-
-from .mutators import SingleGeneMutator, DiscreteGeneMutator, SingleShiftMutator, GeneSwapMutator
+from .mutators import ChangeOneMutator, DiscreteMutator, ShiftOneMutator, SwapMutator
+from .rhc import random_hill_climb
+from .sa import simulated_annealing

src/mlrose_ky/algorithms/crossovers/one_point_crossover.py

@@ -7,9 +7,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Any, Sequence
 
+import numpy as np
+
 from mlrose_ky.algorithms.crossovers._crossover_base import _CrossoverBase
 
 

src/mlrose_ky/algorithms/crossovers/tsp_crossover.py

@@ -8,9 +8,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Any, Sequence
 
+import numpy as np
+
 from mlrose_ky.algorithms.crossovers._crossover_base import _CrossoverBase
 
 

src/mlrose_ky/algorithms/crossovers/uniform_crossover.py

@@ -8,9 +8,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Any, Sequence
 
+import numpy as np
+
 from mlrose_ky.algorithms.crossovers._crossover_base import _CrossoverBase
 
 

src/mlrose_ky/algorithms/decay/__init__.py

@@ -3,7 +3,7 @@
 # Author: Genevieve Hayes
 # License: BSD 3-clause
 
-from .arithmetic_decay import ArithmeticDecay
-from .custom_decay import CustomDecay
-from .exponential_decay import ExponentialDecay
-from .geometric_decay import GeometricDecay, GeomDecay
+from .arithmetic_decay import ArithDecay
+from .custom_decay import CustomSchedule
+from .exponential_decay import ExpDecay
+from .geometric_decay import 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
     """
@@ -55,7 +55,7 @@ def __init__(self, initial_temperature: float = 1.0, decay_rate: float = 0.0001,
 
     def __str__(self) -> str:
         return (
-            f"ArithmeticDecay(initial_temperature={self.initial_temperature}, "
+            f"ArithDecay(initial_temperature={self.initial_temperature}, "
             f"decay_rate={self.decay_rate}, "
             f"minimum_temperature={self.minimum_temperature})"
         )
@@ -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
     """
@@ -34,13 +34,13 @@ def __init__(self, decay_function: Callable[..., float], **kwargs) -> None:
         self.kwargs: dict = kwargs
 
     def __str__(self) -> str:
-        return f"CustomDecay(function={self.decay_function.__name__}, parameters={self.kwargs})"
+        return f"CustomSchedule(function={self.decay_function.__name__}, parameters={self.kwargs})"
 
     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
     """
@@ -57,7 +57,7 @@ def __init__(self, initial_temperature: float = 1.0, decay_rate: float = 0.005,
 
     def __str__(self) -> str:
         return (
-            f"ExponentialDecay(initial_temperature={self.initial_temperature}, "
+            f"ExpDecay(initial_temperature={self.initial_temperature}, "
             f"decay_rate={self.decay_rate}, "
             f"minimum_temperature={self.minimum_temperature})"
         )
@@ -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

@@ -3,10 +3,8 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import warnings
 
-
-class GeometricDecay:
+class GeomDecay:
     """
     Defines a geometric decay schedule for the temperature parameter T in simulated annealing,
     using the formula:
@@ -38,7 +36,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
     """
@@ -57,7 +55,7 @@ def __init__(self, initial_temperature: float = 1.0, decay_rate: float = 0.99, m
 
     def __str__(self) -> str:
         return (
-            f"GeometricDecay(initial_temperature={self.initial_temperature}, "
+            f"GeomDecay(initial_temperature={self.initial_temperature}, "
             f"decay_rate={self.decay_rate}, "
             f"minimum_temperature={self.minimum_temperature})"
         )
@@ -66,7 +64,7 @@ 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
@@ -119,18 +117,3 @@ def get_info(self, time: int | None = None, prefix: str = "") -> dict:
             info[f"{info_prefix}current_value"] = self.evaluate(time)
 
         return info
-
-
-# Enable backward compatibility for renamed 'GeomDecay'.
-class GeomDecay(GeometricDecay):
-    def __new__(cls, *args, **kwargs):
-        """
-        The class 'GeomDecay' is deprecated and will be removed in a future release.
-        Please use 'GeometricDecay' instead.
-        """
-        warnings.warn(
-            "The class 'GeomDecay' is deprecated and will be removed in a future release. " "Please use 'GeometricDecay' instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return super(GeomDecay, cls).__new__(cls)

src/mlrose_ky/algorithms/gd.py

@@ -3,8 +3,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Callable, Any
+
+import numpy as np
+
 from mlrose_ky.decorators import short_name
 from mlrose_ky.neural.utils import flatten_weights
 

src/mlrose_ky/algorithms/hc.py

@@ -3,8 +3,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Callable, Any
+
+import numpy as np
+
 from mlrose_ky.decorators import short_name
 
 

src/mlrose_ky/algorithms/mimic.py

@@ -3,8 +3,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Callable, Any
+
+import numpy as np
+
 from mlrose_ky.decorators import short_name
 
 

src/mlrose_ky/algorithms/mutators/__init__.py

@@ -3,7 +3,7 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-from .discrete_mutator import DiscreteGeneMutator
-from .gene_swap_mutator import GeneSwapMutator
-from .single_gene_mutator import SingleGeneMutator
-from .single_shift_mutator import SingleShiftMutator
+from .discrete_mutator import DiscreteMutator
+from .gene_swap_mutator import SwapMutator
+from .single_gene_mutator import ChangeOneMutator
+from .single_shift_mutator import ShiftOneMutator

src/mlrose_ky/algorithms/mutators/_mutator_base.py

@@ -7,9 +7,10 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
-from typing import Any
 from abc import ABC, abstractmethod
+from typing import Any
+
+import numpy as np
 
 
 class _MutatorBase(ABC):

src/mlrose_ky/algorithms/mutators/discrete_mutator.py

@@ -3,13 +3,14 @@
 # Authors: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3-clause
 
-import numpy as np
 from typing import Any
 
+import numpy as np
+
 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.