Update documentation

Signed-off-by: Dustin DeWeese <[email protected]>

Author: HackerFoo

doc/src/vpr/command_line_usage.rst

@@ -680,6 +680,46 @@ If any of init_t, exit_t or alpha_t is specified, the user schedule, with a fixe
 
     **Default:** ``0.8``
 
+.. option:: --alpha_min <float>
+
+    The minimum (starting) update factor (alpha) used.
+    Ranges between 0 and alpha_max.
+    Setting this flag selects Dusty's annealing schedule.
+
+    **Default:** ``0.2``
+
+.. option:: --alpha_max <float>
+
+    The maximum (stopping) update factor (alpha) used after which simulated annealing will complete.
+    Ranges between alpha_min and 1.
+    Setting this flag selects Dusty's annealing schedule.
+
+    **Default:** ``0.9``
+
+.. option:: --alpha_decay <float>
+
+    The rate at which alpha will approach 1: alpha(n) = 1 - (1 - alpha(n-1)) * alpha_decay
+    Ranges between 0 and 1.
+    Setting this flag selects Dusty's annealing schedule.
+
+    **Default:** ``0.7``
+
+.. option:: --anneal_success_min <float>
+
+   The minimum success ratio after which the temperature will reset to maintain the target success ratio.
+   Ranges between 0 and anneal_success_target.
+   Setting this flag selects Dusty's annealing schedule.
+
+    **Default:** ``0.1``
+
+.. option:: --anneal_success_target <float>
+
+   The temperature after each reset is selected to keep this target success ratio.
+   Ranges between anneal_success_target and 1.
+   Setting this flag selects Dusty's annealing schedule.
+
+    **Default:** ``0.25``
+
 .. option:: --fix_pins {free | random | <file.pads>}
 
     Controls how the placer handles I/O pads during placement.

vpr/src/base/read_options.cpp

@@ -1580,13 +1580,13 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
 
     place_grp.add_argument(args.PlaceAlphaDecay, "--alpha_decay")
         .help(
-            "The value that alpha is scaled by when successful.")
+            "The value that alpha is scaled by after reset.")
         .default_value("0.7")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
     place_grp.add_argument(args.PlaceSuccessMin, "--anneal_success_min")
         .help(
-            "Minimum success ratio when annealing before restarting.")
+            "Minimum success ratio when annealing before resetting the temperature to maintain the target success ratio.")
         .default_value("0.1")
         .show_in(argparse::ShowIn::HELP_ONLY);