Minorly refactor top-of-file docstrings; add self as contributor in m…

…ore author comments

mlrose_hiive/__init__.py

@@ -1,6 +1,6 @@
-""" MLROSe initialization file."""
+"""MLROSe initialization file."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .algorithms.ga import genetic_alg

mlrose_hiive/algorithms/__init__.py

@@ -1,6 +1,6 @@
-""" Classes for defining algorithms problem objects."""
+"""Classes for defining algorithms problem objects."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .ga import (genetic_alg)

mlrose_hiive/algorithms/crossovers/__init__.py

@@ -1,4 +1,4 @@
-""" GA Crossovers."""
+"""GA Crossovers."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/algorithms/crossovers/_crossover_base.py

@@ -1,10 +1,8 @@
-""" Crossover implementations for GA.
-"""
+"""Crossover implementations for GA."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
-
 from abc import ABC, abstractmethod
 
 

mlrose_hiive/algorithms/crossovers/one_point_crossover.py

@@ -1,7 +1,6 @@
-""" Crossover implementations for GA.
-"""
+"""Crossover implementations for GA."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/crossovers/tsp_crossover.py

@@ -1,8 +1,6 @@
-"""
-TSP Crossover implementation for GA.
-"""
+"""TSP Crossover implementation for GA."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/crossovers/uniform_crossover.py

@@ -1,7 +1,6 @@
-""" Crossover implementations for GA.
-"""
+"""Crossover implementations for GA."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/decay/__init__.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/algorithms/decay/arith_decay.py

@@ -1,4 +1,4 @@
-""" Classes for defining decay schedules for simulated annealing."""
+"""Classes for defining decay schedules for simulated annealing."""
 
 
 # Author: Genevieve Hayes

mlrose_hiive/algorithms/decay/custom_schedule.py

@@ -1,4 +1,4 @@
-""" Classes for defining decay schedules for simulated annealing."""
+"""Classes for defining decay schedules for simulated annealing."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/algorithms/decay/exp_decay.py

@@ -1,4 +1,4 @@
-""" Classes for defining decay schedules for simulated annealing."""
+"""Classes for defining decay schedules for simulated annealing."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/algorithms/ga.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/gd.py

@@ -1,6 +1,6 @@
-""" Classes for defining neural network weight optimization problems."""
+"""Classes for defining neural network weight optimization problems."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/hc.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/mimic.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/mutators/__init__.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/mutators/_mutator_base.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/mutators/change_one_mutator.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/mutators/discrete_mutator.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/mutators/shift_one_mutator.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/mutators/swap_mutator.py

@@ -1,4 +1,4 @@
-""" GA Mutators."""
+"""GA Mutators."""
 
 # Author: Genevieve Hayes
 # Modified: Andrew Rollings, Kyle Nakamura

mlrose_hiive/algorithms/rhc.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/algorithms/sa.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/decorators/__init__.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .short_name_decorator import short_name, get_short_name

mlrose_hiive/decorators/short_name_decorator.py

@@ -1,7 +1,7 @@
-""" Functions to implement the randomized optimization and search algorithms.
+"""Functions to implement the randomized optimization and search algorithms.
 """
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 

mlrose_hiive/fitness/continuous_peaks.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/custom_fitness.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/discrete_peaks_base.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 

mlrose_hiive/fitness/flip_flop.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/four_peaks.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/knapsack.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/max_k_color.py

@@ -1,7 +1,7 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 

mlrose_hiive/fitness/one_max.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/queens.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/six_peaks.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/fitness/travelling_sales.py

@@ -1,6 +1,6 @@
-""" Classes for defining fitness functions."""
+"""Classes for defining fitness functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 import numpy as np

mlrose_hiive/generators/__init__.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/generators/continuous_peaks_generator.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 # Author: Andrew Rollings
 # License: BSD 3 clause

mlrose_hiive/generators/flip_flop_generator.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 # Author: Andrew Rollings
 # License: BSD 3 clause

mlrose_hiive/generators/four_peaks_generator.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 import numpy as np
 

mlrose_hiive/generators/knapsack_generator.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 # Author: Genevieve Hayes
 # License: BSD 3 clause

mlrose_hiive/generators/one_max_generator.py

@@ -1,4 +1,4 @@
-""" Classes for defining optimization problem objects."""
+"""Classes for defining optimization problem objects."""
 
 import numpy as np
 

mlrose_hiive/gridsearch/__init__.py

@@ -1,6 +1,6 @@
-""" Classes for gridsearch ."""
+"""Classes for gridsearch ."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .grid_search_mixin import GridSearchMixin

mlrose_hiive/neural/__init__.py

@@ -1,6 +1,6 @@
-""" Classes for defining neural network weight optimization problems."""
+"""Classes for defining neural network weight optimization problems."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .activation import (identity, relu, leaky_relu, sigmoid, softmax, tanh)

mlrose_hiive/neural/_nn_base.py

@@ -1,6 +1,6 @@
-""" Classes for defining neural network weight optimization problems."""
+"""Classes for defining neural network weight optimization problems."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 from abc import ABC, abstractmethod
 

mlrose_hiive/neural/activation/__init__.py

@@ -1,6 +1,6 @@
-""" Classes for defining neural network weight optimization problems."""
+"""Classes for defining neural network weight optimization problems."""
 
-# Author: Genevieve Hayes (modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 
 from .identity import (identity)

mlrose_hiive/neural/activation/identity.py

@@ -1,6 +1,6 @@
-""" Neural network activation functions."""
+"""Neural network activation functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # License: BSD 3 clause
 from mlrose_hiive.decorators import short_name
 

mlrose_hiive/neural/activation/leaky_relu.py

@@ -1,6 +1,6 @@
-""" Neural network activation functions."""
+"""Neural network activation functions."""
 
-# Author: Genevieve Hayes (Modified by Andrew Rollings)
+# Author: Genevieve Hayes (modified by Andrew Rollings, Kyle Nakamura)
 # Contributor : Ankit Grover
 # License: BSD 3 clause
 from mlrose_hiive.decorators import short_name