Skip to content

Commit 159b621

Browse files
MaxBleschamageh
andauthored
Fix some docs errors (#182)
Co-authored-by: Annica Gehlen <ama.gehlen@gmail.com>
1 parent 1499475 commit 159b621

File tree

9 files changed

+161
-159
lines changed

9 files changed

+161
-159
lines changed

docs/source/background/interface_plots.ipynb

Lines changed: 28 additions & 26 deletions
Large diffs are not rendered by default.

docs/source/background/limitations.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
Limitations
44
===========
55

6-
`dc-egm` is a versatile Python package capable of solving and simulating a large class of economic models flexibly and efficiently..
6+
`dcegm` is a versatile Python package capable of solving and simulating a large class of economic models flexibly and efficiently..
77

88
However, there are limitations to what kind of features can be implemented and how complex models can become to be feasible to solve.
99

10-
Below we discuss what kind of models `dc-egm` is designed for and importantly what limitations to be aware of when implementing a model.
10+
Below we discuss what kind of models `dcegm` is designed for and importantly what limitations to be aware of when implementing a model.
1111

12-
What can dc-egm do?
12+
What can dcegm do?
1313
---------------------
1414

1515
The package follows Ishakov et al. (2017) and implements the discrete-continuous endogenous grid method (DC-EGM) for solving dynamic stochastic optimization problems with both discrete and continuous choices. Our code originated as a Python replication of their Matlab code and has since been extended to include additional features and improvements (such as used in Iskhakov and Keane (2021)).
1616

17-
The class of economic models suitable for implementation with `dc-egm` are dynamic discrete-continuous choice models where agents make decisions that include both continuous controls (e.g., consumption or savings) and discrete choices (e.g., labor supply, retirement, or occupational states), potentially influenced by idiosyncratic taste shocks.
17+
The class of economic models suitable for implementation with `dcegm` are dynamic discrete-continuous choice models where agents make decisions that include both continuous controls (e.g., consumption or savings) and discrete choices (e.g., labor supply, retirement, or occupational states), potentially influenced by idiosyncratic taste shocks.
1818

1919
These models are defined by recursive Bellman equations, where the optimal policy must be computed over a joint choice set. Traditional solution methods, such as nested fixed-point or brute-force grid search, are computationally intensive for these settings. The DC-EGM adapts the endogenous grid method to this structure by efficiently solving the Euler equation for the continuous choice conditional on each discrete alternative, thus avoiding costly root-finding or interpolation on the value function.
2020

2121
This makes DC-EGM particularly well-suited for life-cycle models with a modest number of discrete alternatives, especially when taste shocks (e.g., Type I extreme value) allow the use of smooth choice probabilities. In contrast to purely discrete dynamic choice models (e.g., Rust-style models), or models with only continuous controls, DC-EGM addresses hybrid choice problems with substantial gains in speed and accuracy.
2222

2323

24-
What can dc-egm not be used for?
24+
What can `dcegm` not be used for?
2525
---------------------------------
2626

2727
- Purely discrete choice models (see e.g. Keane and Wolpin; 1997)

docs/source/background/specify_exogenous_processes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Overview
55

6-
Exogenous processes in the ```dcegm``` module define how state variables evolve over time based on transition probabilities. These transition probabilities must be properly specified to ensure consistency with the model structure. This document outlines how to define exogenous processes and specify them within the model's ```options``` dictionary.
6+
Exogenous processes in the `dcegm` module define how state variables evolve over time based on transition probabilities. These transition probabilities must be properly specified to ensure consistency with the model structure. This document outlines how to define exogenous processes and specify them within the model's ```options``` dictionary.
77

88
## Defining an Exogenous Process Function
99

@@ -51,7 +51,7 @@ options = {
5151

5252
## Validating Exogenous Processes
5353

54-
To ensure correctness, the validation function can be used as implemented in the ```dcegm``` module:
54+
To ensure correctness, the validation function can be used as implemented in the `dcegm` module:
5555

5656
```python
5757
from dcegm.interfaces.interface import validate_stochastic_states

0 commit comments

Comments
 (0)