Add "out_dir" option to docstrings for all optimizers

Author: anugrahjo

modopt/core/optimization_algorithms/interior_point_dense.py

@@ -23,6 +23,8 @@ class InteriorPoint(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/l2_penalty_eq.py

@@ -21,6 +21,8 @@ class L2PenaltyEq(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/nelder_mead_simplex.py

@@ -18,6 +18,8 @@ class NelderMeadSimplex(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/newton.py

@@ -17,6 +17,8 @@ class Newton(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/newton_lagrange.py

@@ -21,6 +21,8 @@ class NewtonLagrange(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/opensqp.py

@@ -27,6 +27,8 @@ class OpenSQP(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/pso.py

@@ -23,6 +23,8 @@ class PSO(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/quasi_newton.py

@@ -19,6 +19,8 @@ class QuasiNewton(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/simulated_annealing.py

@@ -15,6 +15,8 @@ class SimulatedAnnealing(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.

modopt/core/optimization_algorithms/sqp_dense.py

@@ -22,6 +22,8 @@ class SQP(Optimizer):
         If ``True``, record all outputs from the optimization.
         This needs to be enabled for hot-starting the same problem later,
         if the optimization is interrupted.
+    out_dir : str, optional
+        The directory to store all the output files generated from the optimization.
     hot_start_from : str, optional
         The record file from which to hot-start the optimization.
     hot_start_atol : float, default=0.