Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding necessary functions to time_iteration docstring #205

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

adding necessary functions to time_iteration docstring #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28d30a1
adding necessary functions to time_iteration docstring
sbenthall Jul 7, 2020
d1e59ed
adding functions necessary for each solution algorithm
sbenthall Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/source/algos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
Solution algorithms
*******************

Solution algorithms operate on model objects to determine
the optimal decision rules for the model agents.

Each algorithm requires its target model to have functions
defined in its specification.

This is a mapping between solution algorithm and necessary functions.
Description of these functions, including their type signature,
can be found in the Model Specification.

- Improved time iteration: `transition` and `arbitrage`
- Parameterized expectations : `transition`, `expectation`, and `direct response`
- Perfect foresight: `transition` and `arbitrage`
- Perturbation : `transition` and `arbitrage`
- Steady-state : `transition` and `arbitrage`
- Time iteration: `transition` and `arbitrage`
- Value function iteration : `transition`, and either `felicity` or `value`

.. toctree::
:maxdepth: 2

Expand Down
3 changes: 2 additions & 1 deletion dolo/algos/time_iteration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ def time_iteration(model, dr0=None, with_complementarities=True,
Parameters
----------
model : Model
model to be solved
model to be solved.
Must have ``transition`` and ``arbitrage`` functions.
verbose : boolean
if True, display iterations
dr0 : decision rule
Expand Down