You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: econpizza/solvers/shooting.py
+8-10Lines changed: 8 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -42,26 +42,24 @@ def find_path_shooting(
42
42
shock : tuple, optional
43
43
shock in period 0 as in `(shock_name_as_str, shock_size)`
44
44
horizon : int, optional
45
-
number of periods to simulate
45
+
number of periods to actually simulate. This is NOT the expectations horizon of agents. Defaults to 30
46
46
init_path : array, optional
47
-
a first guess on the trajectory. Normally not necessary
47
+
an initial guess on the trajectory. This should not be necessary
48
48
max_horizon : int, optional
49
-
number of periods until the system is assumed to be back in the steady state. A good idea to set this corresponding to the respective problem. Note that a horizon too far away may cause the accumulation of numerical errors.
49
+
number of periods until the system is assumed to be back in the steady state. A good idea to set this corresponding to the respective problem. Note that a horizon too far away may cause the accumulation of numerical errors. Defaults to 200
50
50
max_loops : int, optional
51
-
number of repetitions to iterate over the whole trajectory. Should eventually be high.
52
-
max_iterations : int, optional
53
-
number of iterations. Default is `max_horizon`. It should not be lower than that (and will raise an error). Normally it should not be higher, better use `max_loops` instead.
51
+
number of repetitions to iterate over the whole trajectory. Should eventually be high. Defaults to 100
52
+
max_iter : int, optional
53
+
number of iterations. Defaults to `max_horizon`. It should not be lower than that (and will raise an error). Normally it should not be higher, better use `max_loops` instead.
54
54
tol : float, optional
55
-
convergence criterion
55
+
convergence criterion, defaults to `1e-5`
56
56
verbose : bool, optional
57
-
degree of verbosity. 0/`False` is silent
57
+
degree of verbosity. 0/`False` is silent. Defualts to `True`
58
58
59
59
Returns
60
60
-------
61
61
x_fin : array
62
62
array of the trajectory
63
-
x_lin : array or None
64
-
array of the trajectory based on the linear model. Will return None if the linear model is unknown
0 commit comments