From b15e7f36e58c9fcaa73da113fceeb634d160dbb5 Mon Sep 17 00:00:00 2001 From: Gregor Boehl Date: Fri, 3 Jan 2025 09:57:34 +0100 Subject: [PATCH] update docs --- econpizza/solvers/stacking.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/econpizza/solvers/stacking.py b/econpizza/solvers/stacking.py index 3a68c56..b19a950 100644 --- a/econpizza/solvers/stacking.py +++ b/econpizza/solvers/stacking.py @@ -44,15 +44,15 @@ def find_path_stacking( init_dist : array, optional initial distribution, defaults to the steady state distribution init_guess : array, optional - initial guess on the sequence trajectory, defaults to the steady state + initial guess on the sequence trajectory (the solution), defaults to the steady state pars : dict, optional - alternative parameters. Warning: do only change those parameters that are invariant to the steady state. + alternative parameters. Warning: it will only be effective to change those parameters that are invariant to the steady state. horizon : int, optional - number of periods until the system is assumed to be back in the steady state. Defaults to ``200`` + number of periods until the system is assumed to be back in the steady state. Finding trajectories with a low horizon is quicker, but chosing a larger horizon may be necessary if the simulated time series do not converge. Defaults to ``200`` use_solid_solver : bool, optional - calculate the full jacobian and use a standard Newton method. Defaults to ``False`` + calculate the full jacobian instead of the iterative approximation, and use a standard Newton method. This usually takes a very long time. Defaults to ``False`` skip_jacobian : bool, optional - whether to skip the calculation of the steady state sequence space Jacobian. If True, the last cached Jacobian will be used. Defaults to ``False`` + whether to skip the calculation of the steady state sequence space Jacobian. If True, the last cached Jacobian will be used. Only use this if you know what you are doing. Defaults to ``False`` verbose : bool, optional degree of verbosity. ``0``/``False`` is silent. Defaults to ``False`` raise_errors : bool, optional