-
-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathchanges.html
More file actions
554 lines (477 loc) · 34.6 KB
/
Copy pathchanges.html
File metadata and controls
554 lines (477 loc) · 34.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>What’s New — CmdStanPy 1.3.0 documentation</title>
<link href="_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link href="_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link rel="stylesheet"
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/project-template.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf">
<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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<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>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Community" href="community.html" />
<link rel="prev" title="Internal API Reference" href="internal_api.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<!-- Google Analytics -->
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<nav id="navbar-main" class="navbar navbar-dark navbar-expand-lg fixed-top bd-navbar"
style="background-color: #222222;"><div class="container-xl">
<div id="navbar-start">
<!-- This will display the version of the docs -->
<a class='navbar-brand' href='index.html'>CmdStanPy 1.3.0</a>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="installation.html">
Installation
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="users-guide.html">
User’s Guide
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="api.html">
API Reference
</a>
</li>
<li class="toctree-l1 current active nav-item">
<a class="current reference internal nav-link" href="#">
What’s New
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="community.html">
Community
</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://twitter.com/mcmc_stan" rel="noopener" target="_blank" title="Twitter"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/stan-dev/cmdstanpy" rel="noopener" target="_blank" title="GitHub"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://discourse.mc-stan.org/" rel="noopener" target="_blank" title="Forums"><span><i class="fas fa-users"></i></span>
<label class="sr-only">Forums</label></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar">
<div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
</div>
</nav>
</div>
<div class="sidebar-end-items">
</div>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<div class="toc-item">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-3-0">
CmdStanPy 1.3.0
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-5">
CmdStanPy 1.2.5
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-4">
CmdStanPy 1.2.4
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-3">
CmdStanPy 1.2.3
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-2">
CmdStanPy 1.2.2
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-1">
CmdStanPy 1.2.1
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-2-0">
CmdStanPy 1.2.0
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-1-0">
CmdStanPy 1.1.0
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-8">
CmdStanPy 1.0.8
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-7">
CmdStanPy 1.0.7
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-6">
CmdStanPy 1.0.6
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-5">
CmdStanPy 1.0.5
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-4">
CmdStanPy 1.0.4
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-3">
CmdStanPy 1.0.3
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-2">
CmdStanPy 1.0.2
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-1">
CmdStanPy 1.0.1
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#cmdstanpy-1-0-0">
CmdStanPy 1.0.0
</a>
</li>
</ul>
</nav>
</div>
<div class="toc-item">
<div class="tocsection editthispage">
<a href="https://github.com/stan-dev/cmdstanpy/edit/develop/docsrc/changes.rst">
<i class="fas fa-pencil-alt"></i> Edit this page
</a>
</div>
</div>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<section id="what-s-new">
<h1>What’s New<a class="headerlink" href="#what-s-new" title="Permalink to this heading">¶</a></h1>
<p>For full changes, see the <a class="reference external" href="https://github.com/stan-dev/cmdstanpy/releases">Releases page</a> on GitHub.</p>
<section id="cmdstanpy-1-3-0">
<h2>CmdStanPy 1.3.0<a class="headerlink" href="#cmdstanpy-1-3-0" title="Permalink to this heading">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><p>Added <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.diagnose" title="cmdstanpy.CmdStanModel.diagnose"><code class="xref py py-meth docutils literal notranslate"><span class="pre">diagnose()</span></code></a> method to <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel" title="cmdstanpy.CmdStanModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanModel</span></code></a></p></li>
<li><p>Added timing information to <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC" title="cmdstanpy.CmdStanMCMC"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanMCMC</span></code></a></p></li>
<li><p>Added <a class="reference internal" href="api.html#cmdstanpy.enable_logging" title="cmdstanpy.enable_logging"><code class="xref py py-func docutils literal notranslate"><span class="pre">enable_logging()</span></code></a> and <a class="reference internal" href="api.html#cmdstanpy.disable_logging" title="cmdstanpy.disable_logging"><code class="xref py py-func docutils literal notranslate"><span class="pre">disable_logging()</span></code></a> functions</p></li>
<li><p>CSV parsing has been rewritten to be faster</p></li>
<li><p>CmdStan path validation only requires <code class="docutils literal notranslate"><span class="pre">makefile</span></code> present</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">create_inits()</span></code> methods to other fit classes, similar to the existing method in <a class="reference internal" href="api.html#cmdstanpy.CmdStanPathfinder" title="cmdstanpy.CmdStanPathfinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanPathfinder</span></code></a></p></li>
<li><p>Cleaned up TQDM usage</p></li>
<li><p>Removed support for Python 3.8</p></li>
<li><p>Deprecated supplying an initial <code class="docutils literal notranslate"><span class="pre">metric</span></code> argument to <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.sample" title="cmdstanpy.CmdStanModel.sample"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sample()</span></code></a> and the <code class="docutils literal notranslate"><span class="pre">metric</span></code> property on <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC" title="cmdstanpy.CmdStanMCMC"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanMCMC</span></code></a>. Both have been renamed to <code class="docutils literal notranslate"><span class="pre">inv_metric</span></code></p></li>
<li><p>Improved compability with Stan 2.37</p></li>
<li><p>Return codes from failing subprocess are now reported unchanged</p></li>
</ul>
</div></blockquote>
<p>Reminder: We anticipate the next release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-5">
<h2>CmdStanPy 1.2.5<a class="headerlink" href="#cmdstanpy-1-2-5" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fixed issues that arose when running a model with no parameters using CmdStan 2.36.0+</p></li>
</ul>
<p>Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-4">
<h2>CmdStanPy 1.2.4<a class="headerlink" href="#cmdstanpy-1-2-4" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fixed a bug in <cite>from_csv</cite> which prevented reading files created by CmdStan 2.35.0+</p></li>
</ul>
<p>Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-3">
<h2>CmdStanPy 1.2.3<a class="headerlink" href="#cmdstanpy-1-2-3" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Updated the logic around reading Stan CSV files to support CmdStan 2.35.0+</p></li>
<li><p>Fixed an issue where the <code class="docutils literal notranslate"><span class="pre">profile_files</span></code> member of the RunSet object was not correct when running multiple chains in the same process.</p></li>
</ul>
<p>Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-2">
<h2>CmdStanPy 1.2.2<a class="headerlink" href="#cmdstanpy-1-2-2" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Updated Community page to link to the <code class="docutils literal notranslate"><span class="pre">bibat</span></code> package.</p></li>
<li><p>Moved CmdStanPy’s metadata to exclusively use the <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file.</p></li>
<li><p>Fixed an issue where the deprecation of the <code class="docutils literal notranslate"><span class="pre">compile=False</span></code> argument to <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel" title="cmdstanpy.CmdStanModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanModel</span></code></a> would
make it impossible to use the canonicalizer to update old models.
The new function <a class="reference internal" href="api.html#cmdstanpy.format_stan_file" title="cmdstanpy.format_stan_file"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.format_stan_file()</span></code></a> supports this use case.</p></li>
<li><p>Fixed a bug preventing multiple inits from being used with <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.pathfinder" title="cmdstanpy.CmdStanModel.pathfinder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.pathfinder()</span></code></a>.</p></li>
<li><p>Added a helper argument <code class="docutils literal notranslate"><span class="pre">num_threads</span></code> to <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.pathfinder" title="cmdstanpy.CmdStanModel.pathfinder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.pathfinder()</span></code></a>.</p></li>
</ul>
<p>Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-1">
<h2>CmdStanPy 1.2.1<a class="headerlink" href="#cmdstanpy-1-2-1" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Switched from <a class="reference external" href="https://numpy.org/doc/stable/reference/random/legacy.html#numpy.random.RandomState" title="(in NumPy v2.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.random.RandomState</span></code></a> to <a class="reference external" href="https://numpy.org/doc/stable/reference/random/generator.html#numpy.random.default_rng" title="(in NumPy v2.3)"><code class="xref py py-func docutils literal notranslate"><span class="pre">default_rng()</span></code></a>.</p></li>
<li><p>Fixed minor doc typos.</p></li>
<li><p>Stan 2.34: Fixed parsing of unit_e output files.</p></li>
<li><p>Stan 2.34: Exposed new Pathfinder arguments.</p></li>
<li><p>Allow the <code class="docutils literal notranslate"><span class="pre">vars</span></code> argument to <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC.draws_pd" title="cmdstanpy.CmdStanMCMC.draws_pd"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMCMC.draws_pd()</span></code></a> to filter the <code class="docutils literal notranslate"><span class="pre">chain__</span></code>, <code class="docutils literal notranslate"><span class="pre">iter__</span></code>, and <code class="docutils literal notranslate"><span class="pre">draws__</span></code> columns.</p></li>
<li><p>Fixed a bug involving the interaction of the <code class="docutils literal notranslate"><span class="pre">adapt_engaged</span></code> and <code class="docutils literal notranslate"><span class="pre">iter_warmup</span></code> arguments to <code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMCMC.sample()</span></code>.</p></li>
</ul>
<p>Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.</p>
</section>
<section id="cmdstanpy-1-2-0">
<h2>CmdStanPy 1.2.0<a class="headerlink" href="#cmdstanpy-1-2-0" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p><strong>New functionality</strong></p>
<ul>
<li><p>The Pathfinder algorithm (available in CmdStan 2.33+) is now availble as <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.pathfinder" title="cmdstanpy.CmdStanModel.pathfinder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.pathfinder()</span></code></a>.</p></li>
<li><p>Laplace approximations (available in CmdStan 2.32+) are now available as <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.laplace_sample" title="cmdstanpy.CmdStanModel.laplace_sample"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.laplace_sample()</span></code></a>.</p></li>
<li><p>The <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.optimize" title="cmdstanpy.CmdStanModel.optimize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.optimize()</span></code></a> method now supports the <code class="docutils literal notranslate"><span class="pre">jacobian</span></code> boolean argument to enable change-of-variables adjustments.
When enabled, the Maximum a posteriori estimate (MAP) is returned, rather than the MLE.</p></li>
<li><p>The <a class="reference internal" href="api.html#cmdstanpy.install_cmdstan" title="cmdstanpy.install_cmdstan"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.install_cmdstan()</span></code></a> function and script can install development versions of CmdStan using the <code class="docutils literal notranslate"><span class="pre">git:</span></code> prefix in the version.</p></li>
</ul>
</li>
<li><p><strong>Deprecations</strong>
The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations. Additional deprecations in this version:</p>
<ul>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanModel" title="cmdstanpy.CmdStanModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdStanModel</span></code></a> will <em>require</em> that it has a compiled executable after construction. The <code class="docutils literal notranslate"><span class="pre">compile</span></code> argument is deprecated,
(the ability to force recompilation is available under the argument <code class="docutils literal notranslate"><span class="pre">force_compile</span></code>), and the <code class="docutils literal notranslate"><span class="pre">compile()</span></code> method is deprecated.
If you wish to compile Stan files independent of constructing a model, use <a class="reference internal" href="api.html#cmdstanpy.compile_stan_file" title="cmdstanpy.compile_stan_file"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.compile_stan_file()</span></code></a>.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanMLE.stan_variable" title="cmdstanpy.CmdStanMLE.stan_variable"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMLE.stan_variable()</span></code></a> will begin returning a <code class="xref py py-class docutils literal notranslate"><span class="pre">np.ndarray</span></code> in all cases, as opposed to the current behavior where sometimes a float is returned.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanVB.stan_variables" title="cmdstanpy.CmdStanVB.stan_variables"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanVB.stan_variables()</span></code></a> will return the _draws_ from the approximate posterior, rather than the optimized mean.
A new argument, <code class="docutils literal notranslate"><span class="pre">mean</span></code>, can be set to True to return the mean instead. Additionally, a <code class="xref py py-class docutils literal notranslate"><span class="pre">np.ndarray</span></code> will be returned in all cases starting in the next version.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.variational" title="cmdstanpy.CmdStanModel.variational"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.variational()</span></code></a> argument <code class="docutils literal notranslate"><span class="pre">output_samples</span></code> will has been renamed to <code class="docutils literal notranslate"><span class="pre">draws</span></code>.</p></li>
</ul>
</li>
<li><p><strong>Other changes</strong></p>
<ul>
<li><p>A list of dictionaries is now allowed as the <code class="docutils literal notranslate"><span class="pre">inits</span></code> argument to <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.sample" title="cmdstanpy.CmdStanModel.sample"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.sample()</span></code></a>.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.install_cmdstan" title="cmdstanpy.install_cmdstan"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.install_cmdstan()</span></code></a> correctly fetches the CmdStan version for ppc64el machines.</p></li>
<li><p>The documentation on how to use external C++ code was updated.</p></li>
<li><p>Various other bug fixes.</p></li>
</ul>
</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The minimum supported version for CmdStanPy is now Python 3.8.</p>
</div>
</section>
<section id="cmdstanpy-1-1-0">
<h2>CmdStanPy 1.1.0<a class="headerlink" href="#cmdstanpy-1-1-0" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p><strong>New functionality</strong></p>
<ul>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.generate_quantities" title="cmdstanpy.CmdStanModel.generate_quantities"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.generate_quantities()</span></code></a> can now accept samples from optimization and variational inference.
The argument <code class="docutils literal notranslate"><span class="pre">mcmc_sample</span></code> has been renamed <code class="docutils literal notranslate"><span class="pre">previous_fit</span></code> to reflect this; the former name is still accepted
but deprecated.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.log_prob" title="cmdstanpy.CmdStanModel.log_prob"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.log_prob()</span></code></a> is able to return the log probability and its gradient with respect to a set of parameters.
<strong>Note</strong> that this is <em>not</em> an efficient way of calculating this in general and should be reserved for debugging
and model development.</p></li>
</ul>
</li>
<li><p><strong>Other changes</strong></p>
<ul>
<li><p>Improved some of the type hints in the package.</p></li>
<li><p>Ensure draws are serialized if a fit object is pickled.</p></li>
<li><p><a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.src_info" title="cmdstanpy.CmdStanModel.src_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">src_info()</span></code></a> now raises an error if the command fails, rather than returning <code class="docutils literal notranslate"><span class="pre">{}</span></code>.</p></li>
<li><p>CmdStanPy has transitioned all unit tests from the <code class="docutils literal notranslate"><span class="pre">unittest</span></code> library to use <code class="docutils literal notranslate"><span class="pre">pytest</span></code>.</p></li>
</ul>
</li>
</ul>
</section>
<section id="cmdstanpy-1-0-8">
<h2>CmdStanPy 1.0.8<a class="headerlink" href="#cmdstanpy-1-0-8" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">install_cmdstan</span></code> now downloads the correct CmdStan for non-x86 Linux machines.</p></li>
<li><p>Improved reporting of errors during <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.compile" title="cmdstanpy.CmdStanModel.compile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">compile()</span></code></a>.</p></li>
<li><p>Fixed some edge cases in mixing arguments of the <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.optimize" title="cmdstanpy.CmdStanModel.optimize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">optimize()</span></code></a> function.</p></li>
<li><p>Fixed how <code class="docutils literal notranslate"><span class="pre">NaN</span></code> and infinite numbers were serialized to JSON.</p></li>
<li><p>Removed dependency on <code class="docutils literal notranslate"><span class="pre">ujson</span></code>. For now, all JSON serialization is done with the Python standard library.</p></li>
<li><p>Added a <code class="docutils literal notranslate"><span class="pre">timeout</span></code> parameter to all model methods which can be used to terminate the CmdStan process after the specified time.</p></li>
<li><p>A model will now properly recompile if one of the <cite>#include</cite>-d files changed since it was last built.</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-7">
<h2>CmdStanPy 1.0.7<a class="headerlink" href="#cmdstanpy-1-0-7" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fixed an issue where complex number containers in Stan program outputs were not being read in properly by CmdStanPy. The output would have the correct shape, but the values would be mixed up.</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-6">
<h2>CmdStanPy 1.0.6<a class="headerlink" href="#cmdstanpy-1-0-6" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fixed a build error in the documentation</p></li>
<li><p>Improved messages when model fails to compile due to C++ errors.</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-5">
<h2>CmdStanPy 1.0.5<a class="headerlink" href="#cmdstanpy-1-0-5" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fixed a typo in <a class="reference internal" href="api.html#cmdstanpy.show_versions" title="cmdstanpy.show_versions"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.show_versions()</span></code></a></p></li>
<li><p>Reorganized and updated the documentation</p></li>
<li><p>Reorganized a lot of internal code</p></li>
<li><p>Cleaned up the output of <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC.draws_pd" title="cmdstanpy.CmdStanMCMC.draws_pd"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMCMC.draws_pd()</span></code></a></p></li>
<li><p>Cleaned up the output of <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC.summary" title="cmdstanpy.CmdStanMCMC.summary"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMCMC.summary()</span></code></a></p></li>
<li><p>Removed the logging which occurred when Python exited with cmdstanpy imported.</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-4">
<h2>CmdStanPy 1.0.4<a class="headerlink" href="#cmdstanpy-1-0-4" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fix an issue with <a class="reference internal" href="api.html#cmdstanpy.install_cmdstan" title="cmdstanpy.install_cmdstan"><code class="xref py py-func docutils literal notranslate"><span class="pre">cmdstanpy.install_cmdstan()</span></code></a> where the installation would report that it had failed even when it had not.</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-3">
<h2>CmdStanPy 1.0.3<a class="headerlink" href="#cmdstanpy-1-0-3" title="Permalink to this heading">¶</a></h2>
<ul>
<li><p>Fix an issue where Stan fit objects were not <code class="docutils literal notranslate"><span class="pre">pickle</span></code>-able when they previously were.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>We still do not recommend pickling cmdstanpy objects, but rather using functions <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC.save_csvfiles" title="cmdstanpy.CmdStanMCMC.save_csvfiles"><code class="xref py py-meth docutils literal notranslate"><span class="pre">save_csvfiles()</span></code></a> and <a class="reference internal" href="api.html#cmdstanpy.from_csv" title="cmdstanpy.from_csv"><code class="xref py py-func docutils literal notranslate"><span class="pre">from_csv()</span></code></a>.</p>
</div>
</li>
</ul>
</section>
<section id="cmdstanpy-1-0-2">
<h2>CmdStanPy 1.0.2<a class="headerlink" href="#cmdstanpy-1-0-2" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>CmdStanPy can now format (and canonicalize) your Stan files with <a class="reference internal" href="api.html#cmdstanpy.CmdStanModel.format" title="cmdstanpy.CmdStanModel.format"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanModel.format()</span></code></a></p></li>
<li><p>Stan variables can now be accessed from fit objects using the <cite>.</cite> syntax when no naming conflicts occur. For example, previous code <code class="docutils literal notranslate"><span class="pre">fit.stan_variable("my_cool_variable")</span></code> can now be written <code class="docutils literal notranslate"><span class="pre">fit.my_cool_variable</span></code></p></li>
<li><p>CmdStanPy is more robust to running in threaded environments and tries harder to not overwrite its own output files</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">install_cmdstan</span></code> script can now be run in interactive mode using <code class="docutils literal notranslate"><span class="pre">--interactive</span></code>/<code class="docutils literal notranslate"><span class="pre">-i</span></code></p></li>
<li><p>CmdStanPy now computes some diagnostics after running HMC and will warn you about post-warmup divergences and treedepth exceptions</p></li>
<li><p>Runtime exceptions in the <code class="docutils literal notranslate"><span class="pre">generated</span> <span class="pre">quantities</span></code> block should be recognized better now.</p></li>
<li><p>The default level of precision used by <a class="reference internal" href="api.html#cmdstanpy.CmdStanMCMC.summary" title="cmdstanpy.CmdStanMCMC.summary"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CmdStanMCMC.summary()</span></code></a> is now 6, as it is when <code class="docutils literal notranslate"><span class="pre">stansummary</span></code> is used from the command line.</p></li>
<li><p>Various documentation improvements</p></li>
</ul>
</section>
<section id="cmdstanpy-1-0-1">
<h2>CmdStanPy 1.0.1<a class="headerlink" href="#cmdstanpy-1-0-1" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Support new optimizations in CmdStan 2.29</p></li>
<li><p>Support complex numbers as both inputs and outputs of Stan programs</p></li>
<li><p>Sped up assembling output by only reading draws at most once</p></li>
<li><p>Fixed an issue where a command failing could change your working directory</p></li>
<li><p>Improve error messages in some cases</p></li>
<li><p>CmdStanPy no longer changes the global root logging level</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The minimum supported version for CmdStanPy is now Python 3.7.</p>
</div>
</section>
<section id="cmdstanpy-1-0-0">
<h2>CmdStanPy 1.0.0<a class="headerlink" href="#cmdstanpy-1-0-0" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Initial release</p></li>
</ul>
</section>
</section>
</div>
<!-- Previous / next buttons -->
<div class='prev-next-area'>
<a class='left-prev' id="prev-link" href="internal_api.html" title="previous page">
<i class="fas fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Internal API Reference</p>
</div>
</a>
<a class='right-next' id="next-link" href="community.html" title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Community</p>
</div>
<i class="fas fa-angle-right"></i>
</a>
</div>
</main>
</div>
</div>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p class="copyright">
© Copyright 2023, Stan Development Team.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br>
</p>
</div>
</div>
</footer>
</body>
</html>