Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ferrall committed Apr 15, 2020
1 parent f086696 commit 4a281cb
Show file tree
Hide file tree
Showing 141 changed files with 3,863 additions and 4,381 deletions.
187 changes: 120 additions & 67 deletions docs/DDP/Bellman.ox.html

Large diffs are not rendered by default.

24 changes: 14 additions & 10 deletions docs/DDP/DDP.ox.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,24 @@ <h2>What Kind of <span class="n">niqlow</span> User Are You?</h2>
<P/>
Before trying to use this documentation or coding with <span class="n">niqlow</span>, consider your background.
<P/>
<DT>If you are new to programming and the Ox language &hellip;</DT>
<DT>You are new to computer programming and the Ox language &hellip;</DT>
<DD>This document may not be the right place to start. You might start with my open online textbook, <a href="https://ferrall.github.io/C4E/">Computation For Economists (C4E)</a>. That text starts with "hello, world" in Ox and covers basic programming skills and numerical algorithms for mathematics. It includes exercises and economic examples.</dd>
<P/>
<DT>If you are an experienced programmer (whether new to Ox or not), but are new to dynamic programming models &hellip;</DT>
<DD>You might start with the <a href="#guide">Beginner's Guide</a> below. That begins with the simplest discrete choice model and how to code it in <span class="n">DDP</span>. It then builds up to a dynamic program.</DD>
<DT>You are an experienced programmer (new to Ox or not), but you are new to dynamic programming models &hellip;</DT>
<DD>You might start with the <a href="#guide">Beginner's Guide</a> below. That begins with the simplest discrete choice model and how to code it in <span class="n">DDP</span>. It then builds up to a dynamic program.</DD>
<P/>
<DT>If you are confident in your knowledge of computer programming and the mathematical technique of dynamic programming as used in economics &hellip;</DT>
<DD>You might start with <a href="GetStarted.html">GetStarted</a> which implements a simple search model in DDP. That jumps right in with a simple dynamic model and Ox code using <span class="n">DDP</span>.</DD>
<DD>You can also start with <a href="https://ferrall.github.io/OODP/">my academic paper</a> that discusses how to build a model from scratch and estimate it using <span class="n">niqlow</span>.</DD>
<DT>You are confident in computer programming and the mathematical technique of dynamic programming as used in economics &hellip;</DT>
<DD>You might start with <a href="GetStarted.html">GetStarted</a> which implements a simple search model in DDP. That jumps right in with a simple dynamic model and Ox code using <span class="n">DDP</span>.</DD>
<DD>You can also start with <a href="https://ferrall.github.io/OODP/">my academic paper</a> that discusses how to build a model from scratch and estimate it using <span class="n">niqlow</span>.</DD>
<P/>
<DT>Finally, if you have already written your code to estimate parameters of a dynamic programming model from data &hellip;</DT>
<DD>You could also start with <a href="https://ferrall.github.io/OODP/">the academic paper</a> and follow the replications of existing models. You could use that to see how you might translate your ideas into <span class="n">niqlow</span> in order to write more flexible, useable and possibly more efficient code.</DD>
<DT>You have already written your own code to estimate parameters of a dynamic programming model from data &hellip;</DT>
<DD>You could also start with <a href="https://ferrall.github.io/OODP/">the academic paper</a> and follow the replications of existing models. You could use that to see how you might translate your ideas into <span class="n">niqlow</span> in order to write more flexible, useable and possibly more efficient code.</DD>
<P/>
This document has two parts. The first begins with the simplest discrete choice problem and how it could be coded in DDP. It builds up to a true dynamic program one feature at a time. The <a href="#tech">second part</a> is a technical description of dynamic programming and DDP. </p>
<h3>This document has two parts.</h3>
<P/>
<DT>Part 1 is a beginner's guide. It starts with the simplest discrete choice problem and how to code it in DDP. From there it builds up to a true dynamic program one feature at a time.</DT>
<P/>
<DT><a href="#tech">Part 2</a> is a technical description of dynamic programming and DDP.</DT>
<P/>
<HR/>
<P/>
Expand Down Expand Up @@ -1336,7 +1340,7 @@ <h3>The generic action space <span class="expressions">\(\alpha \in A\)</span> g
<P/>
</OL>

<dl><dt class="author">Author:</dt><dd class="author">&copy; 2011-2019 <a href="http://econ.queensu.ca/~ferrall">Christopher Ferrall</a></dd></dd>
<dl><dt class="author">Author:</dt><dd class="author">&copy; 2011-2020 <a href="https://ferrall.github.io/">Christopher Ferrall</a></dd></dd>
</dl>
<div class="footer">
Generated by <a href="http://oxdoc.sourceforge.net">oxdoc 1.1-beta</a> &copy Copyright 2005-2014 by Y. Zwols<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/DDP/DDPShared.ox.html
Original file line number Diff line number Diff line change
Expand Up @@ -1533,7 +1533,7 @@ <h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><sp
<table class="parameter_table">
<tr>
<td class="declaration" valign="baseline">nuphase</td>
<td class="description" valign="baseline">NDPhase to start. If INITIALIZING all runtimes are set to 0.<br/>
<td class="description" valign="baseline">DDPhases to start. If INITIALIZING all runtimes are set to 0.<br/>
INBETWEEN [default]. Next phase is not determined at this point.
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/DDP/DP.ox.html
Original file line number Diff line number Diff line change
Expand Up @@ -1632,7 +1632,7 @@ <h3><span class="icon"><img class="icon" src="icons/field.png">&nbsp;</span><spa
<dl><dd>
Volume of output

<dl><dt class="seealso">See also:</dt><dd class="seealso">NoiseLevels.</dd>
<dl><dt class="seealso">See also:</dt><dd class="seealso"><a href="Shared.ox.html#NoiseLevels">NoiseLevels</a></dd>
</dl>
</dd></dl>
<h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><span class="text">DP</span></h2>
Expand Down
Loading

0 comments on commit 4a281cb

Please sign in to comment.