Skip to content

Commit e5793ed

Browse files
lenarddomelenarddome
committed
Deployed a1aed13 with MkDocs version: 1.6.1
1 parent 6ef532e commit e5793ed

File tree

33 files changed

+1911
-8090
lines changed

33 files changed

+1911
-8090
lines changed

‎.DS_Store‎

-8 KB
Binary file not shown.

‎.pages‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎404.html‎

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,13 @@
4444
<li class="toctree-l1"><a class="reference internal" href="/.">Home</a>
4545
</li>
4646
</ul>
47+
<p class="caption"><span class="caption-text">Getting Started</span></p>
4748
<ul>
48-
<li class="toctree-l1"><a class="reference internal" href="/about/">About</a>
49-
</li>
50-
</ul>
51-
<ul>
52-
<li class="toctree-l1"><a class="reference internal" href="/roadmap/">Roadmap</a>
53-
</li>
54-
</ul>
55-
<p class="caption"><span class="caption-text">User Guide</span></p>
56-
<ul>
57-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/getting-started/">Getting Started</a>
58-
</li>
59-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/data-format/">Data formats</a>
60-
</li>
61-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/parameters/">Specify your parameters</a>
49+
<li class="toctree-l1"><a class="reference internal" href="/installation/">Installation</a>
6250
</li>
63-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/defining-model/">Build your model</a>
51+
<li class="toctree-l1"><a class="reference internal" href="/troubleshooting/">Troubleshooting</a>
6452
</li>
65-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/fitting/">Fitting your models to data</a>
66-
</li>
67-
<li class="toctree-l1"><a class="reference internal" href="/tutorials/troubleshooting/">Troubleshooting</a>
53+
<li class="toctree-l1"><a class="reference internal" href="/roadmap/">Roadmap</a>
6854
</li>
6955
</ul>
7056
<p class="caption"><span class="caption-text">Examples</span></p>
@@ -75,22 +61,24 @@
7561
</li>
7662
<li class="toctree-l1"><a class="reference internal" href="/examples/example3/">Example 3: Estimating Empirical Priors</a>
7763
</li>
78-
<li class="toctree-l1"><a class="reference internal" href="/examples/example4/">Example 4: Scaling to the cluster</a>
64+
<li class="toctree-l1"><a class="reference internal" href="/examples/example4/">Example 4: Scale to hypercomputing cluster</a>
65+
</li>
66+
<li class="toctree-l1"><a class="reference internal" href="/examples/example5/">Example 5: Estimating meta-d (metacognitive efficiency)</a>
7967
</li>
8068
</ul>
81-
<p class="caption"><span class="caption-text">API reference</span></p>
69+
<p class="caption"><span class="caption-text">API Reference</span></p>
8270
<ul>
83-
<li class="toctree-l1"><a class="reference internal" href="/references/applications/">cpm.applications</a>
71+
<li class="toctree-l1"><a class="reference internal" href="/api/generators/">cpm.generators</a>
8472
</li>
85-
<li class="toctree-l1"><a class="reference internal" href="/references/models/">cpm.models</a>
73+
<li class="toctree-l1"><a class="reference internal" href="/api/models/">cpm.models</a>
8674
</li>
87-
<li class="toctree-l1"><a class="reference internal" href="/references/generators/">cpm.generators</a>
75+
<li class="toctree-l1"><a class="reference internal" href="/api/optimisation/">cpm.optimisation</a>
8876
</li>
89-
<li class="toctree-l1"><a class="reference internal" href="/references/optimisation/">cpm.optimisation</a>
77+
<li class="toctree-l1"><a class="reference internal" href="/api/hierarchical/">cpm.hierarchical</a>
9078
</li>
91-
<li class="toctree-l1"><a class="reference internal" href="/references/hierarchical/">cpm.hierarchical</a>
79+
<li class="toctree-l1"><a class="reference internal" href="/api/applications/">cpm.applications</a>
9280
</li>
93-
<li class="toctree-l1"><a class="reference internal" href="/references/utils/">cpm.utils</a>
81+
<li class="toctree-l1"><a class="reference internal" href="/api/utils/">cpm.utils</a>
9482
</li>
9583
</ul>
9684
</div>
@@ -151,6 +139,8 @@ <h1 id="404-page-not-found">404</h1>
151139
<script>var base_url = "/";</script>
152140
<script src="/js/theme_extra.js"></script>
153141
<script src="/js/theme.js"></script>
142+
<script src="/."></script>
143+
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
154144
<script src="/search/main.js"></script>
155145
<script>
156146
jQuery(function () {

‎references/applications/index.html‎ renamed to ‎api/applications/index.html‎

Lines changed: 24 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<script>
1616
// Current page data
1717
var mkdocs_page_name = "cpm.applications";
18-
var mkdocs_page_input_path = "references/applications.md";
18+
var mkdocs_page_input_path = "api/applications.md";
1919
var mkdocs_page_url = null;
2020
</script>
2121

@@ -51,27 +51,13 @@
5151
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
5252
</li>
5353
</ul>
54+
<p class="caption"><span class="caption-text">Getting Started</span></p>
5455
<ul>
55-
<li class="toctree-l1"><a class="reference internal" href="../../about/">About</a>
56-
</li>
57-
</ul>
58-
<ul>
59-
<li class="toctree-l1"><a class="reference internal" href="../../roadmap/">Roadmap</a>
60-
</li>
61-
</ul>
62-
<p class="caption"><span class="caption-text">User Guide</span></p>
63-
<ul>
64-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/getting-started/">Getting Started</a>
65-
</li>
66-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/data-format/">Data formats</a>
56+
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Installation</a>
6757
</li>
68-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/parameters/">Specify your parameters</a>
58+
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
6959
</li>
70-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/defining-model/">Build your model</a>
71-
</li>
72-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/fitting/">Fitting your models to data</a>
73-
</li>
74-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/troubleshooting/">Troubleshooting</a>
60+
<li class="toctree-l1"><a class="reference internal" href="../../roadmap/">Roadmap</a>
7561
</li>
7662
</ul>
7763
<p class="caption"><span class="caption-text">Examples</span></p>
@@ -82,11 +68,21 @@
8268
</li>
8369
<li class="toctree-l1"><a class="reference internal" href="../../examples/example3/">Example 3: Estimating Empirical Priors</a>
8470
</li>
85-
<li class="toctree-l1"><a class="reference internal" href="../../examples/example4/">Example 4: Scaling to the cluster</a>
71+
<li class="toctree-l1"><a class="reference internal" href="../../examples/example4/">Example 4: Scale to hypercomputing cluster</a>
72+
</li>
73+
<li class="toctree-l1"><a class="reference internal" href="../../examples/example5/">Example 5: Estimating meta-d (metacognitive efficiency)</a>
8674
</li>
8775
</ul>
88-
<p class="caption"><span class="caption-text">API reference</span></p>
76+
<p class="caption"><span class="caption-text">API Reference</span></p>
8977
<ul class="current">
78+
<li class="toctree-l1"><a class="reference internal" href="../generators/">cpm.generators</a>
79+
</li>
80+
<li class="toctree-l1"><a class="reference internal" href="../models/">cpm.models</a>
81+
</li>
82+
<li class="toctree-l1"><a class="reference internal" href="../optimisation/">cpm.optimisation</a>
83+
</li>
84+
<li class="toctree-l1"><a class="reference internal" href="../hierarchical/">cpm.hierarchical</a>
85+
</li>
9086
<li class="toctree-l1 current"><a class="reference internal current" href="#">cpm.applications</a>
9187
<ul class="current">
9288
<li class="toctree-l2"><a class="reference internal" href="#cpm.applications.reinforcement_learning.RLRW">RLRW</a>
@@ -100,14 +96,6 @@
10096
</ul>
10197
</li>
10298
</ul>
103-
</li>
104-
<li class="toctree-l1"><a class="reference internal" href="../models/">cpm.models</a>
105-
</li>
106-
<li class="toctree-l1"><a class="reference internal" href="../generators/">cpm.generators</a>
107-
</li>
108-
<li class="toctree-l1"><a class="reference internal" href="../optimisation/">cpm.optimisation</a>
109-
</li>
110-
<li class="toctree-l1"><a class="reference internal" href="../hierarchical/">cpm.hierarchical</a>
11199
</li>
112100
<li class="toctree-l1"><a class="reference internal" href="../utils/">cpm.utils</a>
113101
</li>
@@ -126,7 +114,7 @@
126114
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
127115
<ul class="wy-breadcrumbs">
128116
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a></li>
129-
<li class="breadcrumb-item">API reference</li>
117+
<li class="breadcrumb-item">API Reference</li>
130118
<li class="breadcrumb-item active">cpm.applications</li>
131119
<li class="wy-breadcrumbs-aside">
132120
</li>
@@ -544,8 +532,8 @@ <h3 id="cpm.applications.signal_detection.EstimatorMetaD.optimise" class="doc do
544532
</div>
545533
</div><footer>
546534
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
547-
<a href="../../examples/example4/" class="btn btn-neutral float-left" title="Example 4: Scaling to the cluster"><span class="icon icon-circle-arrow-left"></span> Previous</a>
548-
<a href="../models/" class="btn btn-neutral float-right" title="cpm.models">Next <span class="icon icon-circle-arrow-right"></span></a>
535+
<a href="../hierarchical/" class="btn btn-neutral float-left" title="cpm.hierarchical"><span class="icon icon-circle-arrow-left"></span> Previous</a>
536+
<a href="../utils/" class="btn btn-neutral float-right" title="cpm.utils">Next <span class="icon icon-circle-arrow-right"></span></a>
549537
</div>
550538

551539
<hr/>
@@ -568,17 +556,19 @@ <h3 id="cpm.applications.signal_detection.EstimatorMetaD.optimise" class="doc do
568556
<span class="rst-current-version" data-toggle="rst-current-version">
569557

570558

571-
<span><a href="../../examples/example4/" style="color: #fcfcfc">&laquo; Previous</a></span>
559+
<span><a href="../hierarchical/" style="color: #fcfcfc">&laquo; Previous</a></span>
572560

573561

574-
<span><a href="../models/" style="color: #fcfcfc">Next &raquo;</a></span>
562+
<span><a href="../utils/" style="color: #fcfcfc">Next &raquo;</a></span>
575563

576564
</span>
577565
</div>
578566
<script src="../../js/jquery-3.6.0.min.js"></script>
579567
<script>var base_url = "../..";</script>
580568
<script src="../../js/theme_extra.js"></script>
581569
<script src="../../js/theme.js"></script>
570+
<script src="../.."></script>
571+
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
582572
<script src="../../search/main.js"></script>
583573
<script>
584574
jQuery(function () {

‎references/generators/index.html‎ renamed to ‎api/generators/index.html‎

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<script>
1616
// Current page data
1717
var mkdocs_page_name = "cpm.generators";
18-
var mkdocs_page_input_path = "references/generators.md";
18+
var mkdocs_page_input_path = "api/generators.md";
1919
var mkdocs_page_url = null;
2020
</script>
2121

@@ -51,27 +51,13 @@
5151
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
5252
</li>
5353
</ul>
54+
<p class="caption"><span class="caption-text">Getting Started</span></p>
5455
<ul>
55-
<li class="toctree-l1"><a class="reference internal" href="../../about/">About</a>
56-
</li>
57-
</ul>
58-
<ul>
59-
<li class="toctree-l1"><a class="reference internal" href="../../roadmap/">Roadmap</a>
60-
</li>
61-
</ul>
62-
<p class="caption"><span class="caption-text">User Guide</span></p>
63-
<ul>
64-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/getting-started/">Getting Started</a>
65-
</li>
66-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/data-format/">Data formats</a>
67-
</li>
68-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/parameters/">Specify your parameters</a>
69-
</li>
70-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/defining-model/">Build your model</a>
56+
<li class="toctree-l1"><a class="reference internal" href="../../installation/">Installation</a>
7157
</li>
72-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/fitting/">Fitting your models to data</a>
58+
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
7359
</li>
74-
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/troubleshooting/">Troubleshooting</a>
60+
<li class="toctree-l1"><a class="reference internal" href="../../roadmap/">Roadmap</a>
7561
</li>
7662
</ul>
7763
<p class="caption"><span class="caption-text">Examples</span></p>
@@ -82,15 +68,13 @@
8268
</li>
8369
<li class="toctree-l1"><a class="reference internal" href="../../examples/example3/">Example 3: Estimating Empirical Priors</a>
8470
</li>
85-
<li class="toctree-l1"><a class="reference internal" href="../../examples/example4/">Example 4: Scaling to the cluster</a>
71+
<li class="toctree-l1"><a class="reference internal" href="../../examples/example4/">Example 4: Scale to hypercomputing cluster</a>
72+
</li>
73+
<li class="toctree-l1"><a class="reference internal" href="../../examples/example5/">Example 5: Estimating meta-d (metacognitive efficiency)</a>
8674
</li>
8775
</ul>
88-
<p class="caption"><span class="caption-text">API reference</span></p>
76+
<p class="caption"><span class="caption-text">API Reference</span></p>
8977
<ul class="current">
90-
<li class="toctree-l1"><a class="reference internal" href="../applications/">cpm.applications</a>
91-
</li>
92-
<li class="toctree-l1"><a class="reference internal" href="../models/">cpm.models</a>
93-
</li>
9478
<li class="toctree-l1 current"><a class="reference internal current" href="#">cpm.generators</a>
9579
<ul class="current">
9680
<li class="toctree-l2"><a class="reference internal" href="#cpm.generators.Value">Value</a>
@@ -156,11 +140,15 @@
156140
</ul>
157141
</li>
158142
</ul>
143+
</li>
144+
<li class="toctree-l1"><a class="reference internal" href="../models/">cpm.models</a>
159145
</li>
160146
<li class="toctree-l1"><a class="reference internal" href="../optimisation/">cpm.optimisation</a>
161147
</li>
162148
<li class="toctree-l1"><a class="reference internal" href="../hierarchical/">cpm.hierarchical</a>
163149
</li>
150+
<li class="toctree-l1"><a class="reference internal" href="../applications/">cpm.applications</a>
151+
</li>
164152
<li class="toctree-l1"><a class="reference internal" href="../utils/">cpm.utils</a>
165153
</li>
166154
</ul>
@@ -178,7 +166,7 @@
178166
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
179167
<ul class="wy-breadcrumbs">
180168
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a></li>
181-
<li class="breadcrumb-item">API reference</li>
169+
<li class="breadcrumb-item">API Reference</li>
182170
<li class="breadcrumb-item active">cpm.generators</li>
183171
<li class="wy-breadcrumbs-aside">
184172
</li>
@@ -1100,7 +1088,6 @@ <h2 id="cpm.generators.Wrapper" class="doc doc-heading">
11001088
<li>'dependent': Any dependent variables calculated by the model that will be used for the loss function.</li>
11011089
</ul>
11021090
<p>If a model output contains any keys that are also present in parameters, it updates those in the parameters based on the model output.</p>
1103-
<p>Information on how to compile the model can be found in the [Tutorials - Build your model][/tutorials/defining-model] module.</p>
11041091
</details>
11051092

11061093

@@ -1714,8 +1701,8 @@ <h3 id="cpm.generators.Simulator.update" class="doc doc-heading">
17141701
</div>
17151702
</div><footer>
17161703
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
1717-
<a href="../models/" class="btn btn-neutral float-left" title="cpm.models"><span class="icon icon-circle-arrow-left"></span> Previous</a>
1718-
<a href="../optimisation/" class="btn btn-neutral float-right" title="cpm.optimisation">Next <span class="icon icon-circle-arrow-right"></span></a>
1704+
<a href="../../examples/example5/" class="btn btn-neutral float-left" title="Example 5: Estimating meta-d (metacognitive efficiency)"><span class="icon icon-circle-arrow-left"></span> Previous</a>
1705+
<a href="../models/" class="btn btn-neutral float-right" title="cpm.models">Next <span class="icon icon-circle-arrow-right"></span></a>
17191706
</div>
17201707

17211708
<hr/>
@@ -1738,17 +1725,19 @@ <h3 id="cpm.generators.Simulator.update" class="doc doc-heading">
17381725
<span class="rst-current-version" data-toggle="rst-current-version">
17391726

17401727

1741-
<span><a href="../models/" style="color: #fcfcfc">&laquo; Previous</a></span>
1728+
<span><a href="../../examples/example5/" style="color: #fcfcfc">&laquo; Previous</a></span>
17421729

17431730

1744-
<span><a href="../optimisation/" style="color: #fcfcfc">Next &raquo;</a></span>
1731+
<span><a href="../models/" style="color: #fcfcfc">Next &raquo;</a></span>
17451732

17461733
</span>
17471734
</div>
17481735
<script src="../../js/jquery-3.6.0.min.js"></script>
17491736
<script>var base_url = "../..";</script>
17501737
<script src="../../js/theme_extra.js"></script>
17511738
<script src="../../js/theme.js"></script>
1739+
<script src="../.."></script>
1740+
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
17521741
<script src="../../search/main.js"></script>
17531742
<script>
17541743
jQuery(function () {

0 commit comments

Comments
 (0)