Skip to content

Commit f237e8d

Browse files
github-actions[bot]github-actions[bot]
committed
release/v0.9.77: updating version numbers
1 parent 6b1f2ae commit f237e8d

26 files changed

Lines changed: 7565 additions & 340 deletions

‎docs/_images/examples_MCMC_Sampling_18_2.png‎

215 Bytes
Loading

‎docs/_modules/cmdstanpy/model.html‎

Lines changed: 1518 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/cmdstanpy/stanfit.html‎

Lines changed: 2512 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/cmdstanpy/utils.html‎

Lines changed: 1464 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/index.html‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html>
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Overview: module code &#8212; CmdStanPy 0.9.77 documentation</title>
9+
10+
<link href="../_static/css/theme.css" rel="stylesheet" />
11+
<link href="../_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
12+
13+
14+
<link rel="stylesheet"
15+
href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
16+
<link rel="preload" as="font" type="font/woff2" crossorigin
17+
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
18+
<link rel="preload" as="font" type="font/woff2" crossorigin
19+
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
20+
21+
22+
23+
24+
25+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
26+
<link rel="stylesheet" type="text/css" href="../_static/css/project-template.css" />
27+
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
28+
29+
<link rel="preload" as="script" href="../_static/js/index.1c5a1a01449ed65a7b51.js">
30+
31+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
32+
<script src="../_static/jquery.js"></script>
33+
<script src="../_static/underscore.js"></script>
34+
<script src="../_static/doctools.js"></script>
35+
<script src="../_static/clipboard.min.js"></script>
36+
<script src="../_static/copybutton.js"></script>
37+
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
38+
<link rel="index" title="Index" href="../genindex.html" />
39+
<link rel="search" title="Search" href="../search.html" />
40+
41+
<meta name="viewport" content="width=device-width, initial-scale=1" />
42+
<meta name="docsearch:language" content="en" />
43+
44+
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
45+
46+
</head>
47+
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
48+
49+
<div class="container-fluid" id="banner"></div>
50+
51+
52+
<nav id="navbar-main" class="navbar navbar-dark navbar-expand-lg fixed-top bd-navbar"
53+
style="background-color: #222222;"><div class="container-xl">
54+
55+
<div id="navbar-start">
56+
57+
<!-- This will display the version of the docs -->
58+
<a class='navbar-brand' href='index.html'>CmdStanPy 0.9.77</a>
59+
60+
</div>
61+
62+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
63+
<span class="navbar-toggler-icon"></span>
64+
</button>
65+
66+
67+
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
68+
<div id="navbar-center" class="mr-auto">
69+
70+
<div class="navbar-center-item">
71+
<ul id="navbar-main-elements" class="navbar-nav">
72+
<li class="toctree-l1 nav-item">
73+
<a class="reference internal nav-link" href="../overview.html">
74+
Overview
75+
</a>
76+
</li>
77+
78+
<li class="toctree-l1 nav-item">
79+
<a class="reference internal nav-link" href="../installation.html">
80+
Installation
81+
</a>
82+
</li>
83+
84+
<li class="toctree-l1 nav-item">
85+
<a class="reference internal nav-link" href="../hello_world.html">
86+
“Hello, World”
87+
</a>
88+
</li>
89+
90+
<li class="toctree-l1 nav-item">
91+
<a class="reference internal nav-link" href="../workflow.html">
92+
CmdStanPy Workflow
93+
</a>
94+
</li>
95+
96+
<li class="toctree-l1 nav-item">
97+
<a class="reference internal nav-link" href="../examples.html">
98+
CmdStanPy Examples
99+
</a>
100+
</li>
101+
102+
<li class="toctree-l1 nav-item">
103+
<a class="reference internal nav-link" href="../api.html">
104+
API Reference
105+
</a>
106+
</li>
107+
108+
109+
</ul>
110+
</div>
111+
112+
</div>
113+
114+
<div id="navbar-end">
115+
116+
<div class="navbar-end-item">
117+
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
118+
<li class="nav-item">
119+
<a class="nav-link" href="https://twitter.com/mcmc_stan" rel="noopener" target="_blank" title="Twitter">
120+
<span><i class="fab fa-twitter"></i></span>
121+
<label class="sr-only">Twitter</label>
122+
</a>
123+
</li>
124+
<li class="nav-item">
125+
<a class="nav-link" href="https://github.com/stan-dev/cmdstanpy" rel="noopener" target="_blank" title="GitHub">
126+
<span><i class="fab fa-github"></i></span>
127+
<label class="sr-only">GitHub</label>
128+
</a>
129+
</li>
130+
<li class="nav-item">
131+
<a class="nav-link" href="https://discourse.mc-stan.org/" rel="noopener" target="_blank" title="Forums">
132+
<span><i class="fas fa-users"></i></span>
133+
<label class="sr-only">Forums</label>
134+
</a>
135+
</li>
136+
</ul>
137+
</div>
138+
139+
</div>
140+
</div>
141+
</div>
142+
</nav>
143+
144+
145+
<div class="container-xl">
146+
<div class="row">
147+
148+
149+
<div class="col-12 col-md-1 col-xl-2 bd-sidebar no-sidebar"></div>
150+
151+
152+
153+
154+
<div class="d-none d-xl-block col-xl-2 bd-toc">
155+
156+
</div>
157+
158+
159+
160+
161+
162+
163+
<main class="col-12 col-md-11 col-xl-8 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
164+
165+
<div>
166+
167+
<h1>All modules for which code is available</h1>
168+
<ul><li><a href="cmdstanpy/model.html">cmdstanpy.model</a></li>
169+
<li><a href="cmdstanpy/stanfit.html">cmdstanpy.stanfit</a></li>
170+
<li><a href="cmdstanpy/utils.html">cmdstanpy.utils</a></li>
171+
</ul>
172+
173+
</div>
174+
175+
176+
<div class='prev-next-bottom'>
177+
178+
179+
</div>
180+
181+
</main>
182+
183+
184+
</div>
185+
</div>
186+
187+
<script src="../_static/js/index.1c5a1a01449ed65a7b51.js"></script>
188+
189+
<footer class="footer mt-5 mt-md-0">
190+
<div class="container">
191+
192+
<div class="footer-item">
193+
<p class="copyright">
194+
&copy; Copyright 2021, Stan Development Team.<br/>
195+
</p>
196+
</div>
197+
198+
<div class="footer-item">
199+
<p class="sphinx-version">
200+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.1.2.<br/>
201+
</p>
202+
</div>
203+
204+
</div>
205+
</footer>
206+
</body>
207+
</html>

‎docs/_sources/api.rst.txt‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
.. py:currentmodule:: cmdstanpy
2+
3+
#############
4+
API Reference
5+
#############
6+
7+
*******
8+
Classes
9+
*******
10+
11+
CmdStanModel
12+
============
13+
14+
A CmdStanModel object encapsulates the Stan program. It manages program compilation and provides the following inference methods:
15+
16+
:meth:`~CmdStanModel.sample`
17+
runs the HMC-NUTS sampler to produce a set of draws from the posterior distribution.
18+
19+
:meth:`~CmdStanModel.optimize`
20+
produce a penalized maximum likelihood estimate (point estimate) of the model parameters.
21+
22+
:meth:`~CmdStanModel.variational`
23+
run CmdStan’s variational inference algorithm to approximate the posterior distribution.
24+
25+
:meth:`~CmdStanModel.generate_quantities`
26+
runs CmdStan’s generate_quantities method to produce additional quantities of interest based on draws from an existing sample.
27+
28+
.. autoclass:: cmdstanpy.CmdStanModel
29+
:members:
30+
31+
32+
CmdStanMCMC
33+
===========
34+
35+
.. autoclass:: cmdstanpy.CmdStanMCMC
36+
:members:
37+
38+
CmdStanMLE
39+
==========
40+
41+
.. autoclass:: cmdstanpy.CmdStanMLE
42+
:members:
43+
44+
CmdStanGQ
45+
=========
46+
47+
.. autoclass:: cmdstanpy.CmdStanGQ
48+
:members:
49+
50+
CmdStanVB
51+
=========
52+
53+
.. autoclass:: cmdstanpy.CmdStanVB
54+
:members:
55+
56+
57+
InferenceMetadata
58+
=================
59+
60+
.. autoclass:: cmdstanpy.InferenceMetadata
61+
:members:
62+
63+
RunSet
64+
======
65+
66+
.. autoclass:: cmdstanpy.stanfit.RunSet
67+
:members:
68+
69+
*********
70+
Functions
71+
*********
72+
73+
cmdstan_path
74+
============
75+
76+
.. autofunction:: cmdstanpy.cmdstan_path
77+
78+
install_cmdstan
79+
===============
80+
81+
.. autofunction:: cmdstanpy.install_cmdstan
82+
83+
set_cmdstan_path
84+
================
85+
86+
.. autofunction:: cmdstanpy.set_cmdstan_path
87+
88+
set_make_env
89+
============
90+
91+
.. autofunction:: cmdstanpy.set_make_env
92+
93+
from_csv
94+
========
95+
96+
.. autofunction:: cmdstanpy.from_csv
97+
98+
write_stan_json
99+
===============
100+
101+
.. autofunction:: cmdstanpy.write_stan_json

‎docs/_sources/examples.rst.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
CmdStanPy Examples
2+
__________________
3+
4+
.. toctree::
5+
:titlesonly:
6+
7+
examples/MCMC Sampling.ipynb
8+
examples/Maximum Likelihood Estimation.ipynb
9+
examples/Variational Inference.ipynb
10+
examples/Run Generated Quantities.ipynb

0 commit comments

Comments
 (0)