Skip to content

Commit

Permalink
update website docs to 0.15.7
Browse files Browse the repository at this point in the history
  • Loading branch information
douglasrizzo committed Jun 13, 2021
1 parent ae36bd0 commit 2989733
Show file tree
Hide file tree
Showing 52 changed files with 443 additions and 323 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 82bbd6a1fb4f9f313b400e0081095ab3
config: 1a7003f9672146186db44e6884175692
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/cat.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/introduction.doctree
Binary file not shown.
Binary file modified docs/.doctrees/irt.doctree
Binary file not shown.
Binary file modified docs/.doctrees/plot.doctree
Binary file not shown.
Binary file modified docs/.doctrees/readme_body.doctree
Binary file not shown.
Binary file modified docs/.doctrees/selection.doctree
Binary file not shown.
Binary file modified docs/.doctrees/simulation.doctree
Binary file not shown.
Binary file modified docs/.doctrees/stopping.doctree
Binary file not shown.
Binary file modified docs/_images/introduction-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions docs/_modules/catsim/cat.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

<script type="text/javascript" src="../../_static/js/theme.js"></script>

Expand Down Expand Up @@ -68,7 +68,7 @@


<div class="version">
0.15.6
0.15.7
</div>


Expand Down Expand Up @@ -176,9 +176,9 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Functions used specifically during the application/simulation of computerized adaptive tests.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">operator</span>
<span class="kn">import</span> <span class="nn">random</span>

<span class="kn">import</span> <span class="nn">numpy</span>
<span class="kn">import</span> <span class="nn">random</span>

<span class="kn">from</span> <span class="nn">catsim</span> <span class="kn">import</span> <span class="n">irt</span>

Expand Down Expand Up @@ -207,9 +207,9 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">theta</span> <span class="o">+</span> <span class="p">((</span><span class="nb">max</span><span class="p">(</span><span class="n">b</span><span class="p">)</span> <span class="o">-</span> <span class="n">theta</span><span class="p">)</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="k">if</span> <span class="n">correct</span> <span class="k">else</span> <span class="n">theta</span> <span class="o">-</span> <span class="p">((</span><span class="n">theta</span> <span class="o">-</span> <span class="nb">min</span><span class="p">(</span><span class="n">b</span><span class="p">))</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span></div>


<div class="viewcode-block" id="bias"><a class="viewcode-back" href="../../cat.html#catsim.cat.bias">[docs]</a><span class="k">def</span> <span class="nf">bias</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
<div class="viewcode-block" id="bias"><a class="viewcode-back" href="../../cat.html#catsim.cat.bias">[docs]</a><span class="k">def</span> <span class="nf">bias</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Calculates the test bias, an evaluation criterion for computerized adaptive test methodolgies [Chang2001]_.</span>
<span class="sd"> The value is calculated by:</span>
<span class="sd"> The value is computed as:</span>

<span class="sd"> .. math:: Bias = \\frac{\\sum_{i=1}^{N} (\\hat{\\theta}_i - \\theta_{i})}{N}</span>

Expand All @@ -222,13 +222,13 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">actual</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">predicted</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;actual and predicted vectors need to be the same size&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">numpy</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> <span class="n">predicted</span><span class="p">,</span> <span class="n">actual</span><span class="p">)))</span></div>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> <span class="n">predicted</span><span class="p">,</span> <span class="n">actual</span><span class="p">))))</span></div>


<div class="viewcode-block" id="mse"><a class="viewcode-back" href="../../cat.html#catsim.cat.mse">[docs]</a><span class="k">def</span> <span class="nf">mse</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
<div class="viewcode-block" id="mse"><a class="viewcode-back" href="../../cat.html#catsim.cat.mse">[docs]</a><span class="k">def</span> <span class="nf">mse</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Mean squared error, a value used when measuring the precision</span>
<span class="sd"> with which a computerized adaptive test estimates examinees proficiencies [Chang2001]_.</span>
<span class="sd"> The value is calculated by:</span>
<span class="sd"> The value is computed as:</span>

<span class="sd"> .. math:: MSE = \\frac{\\sum_{i=1}^{N} (\\hat{\\theta}_i - \\theta_{i})^2}{N}</span>

Expand All @@ -241,13 +241,13 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">actual</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">predicted</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;actual and predicted vectors need to be the same size&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">numpy</span><span class="o">.</span><span class="n">mean</span><span class="p">([</span><span class="n">x</span> <span class="o">*</span> <span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> <span class="n">predicted</span><span class="p">,</span> <span class="n">actual</span><span class="p">))])</span></div>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">mean</span><span class="p">([</span><span class="n">x</span> <span class="o">*</span> <span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span> <span class="n">predicted</span><span class="p">,</span> <span class="n">actual</span><span class="p">))]))</span></div>


<div class="viewcode-block" id="rmse"><a class="viewcode-back" href="../../cat.html#catsim.cat.rmse">[docs]</a><span class="k">def</span> <span class="nf">rmse</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
<div class="viewcode-block" id="rmse"><a class="viewcode-back" href="../../cat.html#catsim.cat.rmse">[docs]</a><span class="k">def</span> <span class="nf">rmse</span><span class="p">(</span><span class="n">actual</span><span class="p">:</span> <span class="nb">list</span><span class="p">,</span> <span class="n">predicted</span><span class="p">:</span> <span class="nb">list</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Root mean squared error, a common value used when measuring the precision</span>
<span class="sd"> with which a computerized adaptive test estimates examinees proficiencies [Bar10]_.</span>
<span class="sd"> The value is calculated by:</span>
<span class="sd"> The value is computed as:</span>

<span class="sd"> .. math:: RMSE = \\sqrt{\\frac{\\sum_{i=1}^{N} (\\hat{\\theta}_i - \\theta_{i})^2}{N}}</span>

Expand Down Expand Up @@ -286,7 +286,7 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">t</span></div>


<div class="viewcode-block" id="generate_item_bank"><a class="viewcode-back" href="../../cat.html#catsim.cat.generate_item_bank">[docs]</a><span class="k">def</span> <span class="nf">generate_item_bank</span><span class="p">(</span><span class="n">n</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">itemtype</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;4PL&#39;</span><span class="p">,</span> <span class="n">corr</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<div class="viewcode-block" id="generate_item_bank"><a class="viewcode-back" href="../../cat.html#catsim.cat.generate_item_bank">[docs]</a><span class="k">def</span> <span class="nf">generate_item_bank</span><span class="p">(</span><span class="n">n</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">itemtype</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;4PL&#39;</span><span class="p">,</span> <span class="n">corr</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">numpy</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Generate a synthetic item bank whose parameters approximately follow</span>
<span class="sd"> real-world parameters, as proposed by [Bar10]_.</span>

Expand Down Expand Up @@ -348,7 +348,7 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">irt</span><span class="o">.</span><span class="n">normalize_item_bank</span><span class="p">(</span><span class="n">numpy</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">d</span><span class="p">])</span><span class="o">.</span><span class="n">T</span><span class="p">)</span></div>


<span class="k">def</span> <span class="nf">random_response_vector</span><span class="p">(</span><span class="n">size</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">random_response_vector</span><span class="p">(</span><span class="n">size</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="nb">bool</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">getrandbits</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">size</span><span class="p">)]</span>


Expand All @@ -367,7 +367,7 @@ <h1>Source code for catsim.cat</h1><div class="highlight"><pre>

<div role="contentinfo">
<p>
&#169; Copyright 2020, Douglas De Rizzo Meneghetti.
&#169; Copyright 2021, Douglas De Rizzo Meneghetti.

</p>
</div>
Expand Down
Loading

0 comments on commit 2989733

Please sign in to comment.