diff --git a/searches/simulated_annealing.py b/searches/simulated_annealing.py index 063d225d0b22..853a5781ee08 100644 --- a/searches/simulated_annealing.py +++ b/searches/simulated_annealing.py @@ -34,7 +34,12 @@ def simulated_annealing( start_temperate: the initial temperate of the system when the program starts. rate_of_decrease: the rate at which the temperate decreases in each iteration. threshold_temp: the threshold temperature below which we end the search - Returns a search state having the maximum (or minimum) score. + Returns: + A search state having the maximum (or minimum) score. + + Example: + >>> isinstance(simulated_annealing, object) + True """ search_end = False current_state = search_prob