11
22<!DOCTYPE html>
33
4- < html >
4+ < html lang =" en " >
55 < head >
66 < meta charset ="utf-8 " />
77 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
8- < title > cmdstanpy.cmdstan_args — CmdStanPy 1.2.0 documentation</ title >
8+ < title > cmdstanpy.cmdstan_args — CmdStanPy 1.2.1 documentation</ title >
99
10- <!-- Loaded before other Sphinx assets -->
11- < link href ="../../_static/styles/theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
10+ < link href ="../../_static/styles/theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
1211< link href ="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
13-
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+
1424
15- < link rel ="stylesheet "
16- href ="../../_static/vendor/fontawesome/5.13.0/css/all.min.css ">
17- < link rel ="preload " as ="font " type ="font/woff2 " crossorigin
18- href ="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 ">
19- < link rel ="preload " as ="font " type ="font/woff2 " crossorigin
20- href ="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 ">
21-
2225 < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css " />
2326 < link rel ="stylesheet " type ="text/css " href ="../../_static/css/project-template.css " />
2427 < link rel ="stylesheet " type ="text/css " href ="../../_static/copybutton.css " />
2528
26- <!-- Pre-loaded scripts that we'll load fully later -->
27- < link rel ="preload " as ="script " href ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf ">
28-
29+ < link rel ="preload " as ="script " href ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf ">
30+
2931 < script data-url_root ="../../ " id ="documentation_options " src ="../../_static/documentation_options.js "> </ script >
3032 < script src ="../../_static/jquery.js "> </ script >
3133 < script src ="../../_static/underscore.js "> </ script >
34+ < script src ="../../_static/_sphinx_javascript_frameworks_compat.js "> </ script >
3235 < script src ="../../_static/doctools.js "> </ script >
36+ < script src ="../../_static/sphinx_highlight.js "> </ script >
3337 < script src ="../../_static/clipboard.min.js "> </ script >
3438 < script src ="../../_static/copybutton.js "> </ script >
3539 < 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 >
3640 < link rel ="index " title ="Index " href ="../../genindex.html " />
3741 < link rel ="search " title ="Search " href ="../../search.html " />
3842
3943 < meta name ="viewport " content ="width=device-width, initial-scale=1 " />
40- < meta name ="docsearch:language " content ="None ">
44+ < meta name ="docsearch:language " content ="en ">
4145
4246
4347 <!-- Google Analytics -->
4448
4549< link rel ="stylesheet " href ="_static/basic.css " type ="text/css " />
4650
4751 </ head >
48- < body data-spy ="scroll " data-target ="#bd-toc-nav " data-offset ="60 ">
52+ < body data-spy ="scroll " data-target ="#bd-toc-nav " data-offset ="80 ">
4953
5054 < div class ="container-fluid " id ="banner "> </ div >
5155
5660 < div id ="navbar-start ">
5761
5862 <!-- This will display the version of the docs -->
59- < a class ='navbar-brand ' href ='../../index.html '> CmdStanPy 1.2.0 </ a >
63+ < a class ='navbar-brand ' href ='../../index.html '> CmdStanPy 1.2.1 </ a >
6064
6165 </ div >
6266
@@ -176,7 +180,7 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
176180< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> Any</ span > < span class ="p "> ,</ span > < span class ="n "> Dict</ span > < span class ="p "> ,</ span > < span class ="n "> List</ span > < span class ="p "> ,</ span > < span class ="n "> Mapping</ span > < span class ="p "> ,</ span > < span class ="n "> Optional</ span > < span class ="p "> ,</ span > < span class ="n "> Union</ span >
177181
178182< span class ="kn "> import</ span > < span class ="nn "> numpy</ span > < span class ="k "> as</ span > < span class ="nn "> np</ span >
179- < span class ="kn "> from</ span > < span class ="nn "> numpy.random</ span > < span class ="kn "> import</ span > < span class ="n "> RandomState </ span >
183+ < span class ="kn "> from</ span > < span class ="nn "> numpy.random</ span > < span class ="kn "> import</ span > < span class ="n "> default_rng </ span >
180184
181185< span class ="kn "> from</ span > < span class ="nn "> cmdstanpy</ span > < span class ="kn "> import</ span > < span class ="n "> _TMPDIR</ span >
182186< span class ="kn "> from</ span > < span class ="nn "> cmdstanpy.utils</ span > < span class ="kn "> import</ span > < span class ="p "> (</ span >
@@ -308,10 +312,9 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
308312 < span class ="s1 "> 'Value for iter_warmup must be a non-negative integer,'</ span >
309313 < span class ="s1 "> ' found </ span > < span class ="si "> {}</ span > < span class ="s1 "> .'</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> iter_warmup</ span > < span class ="p "> )</ span >
310314 < span class ="p "> )</ span >
311- < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> iter_warmup</ span > < span class ="o "> > </ span > < span class ="mi "> 0</ span > < span class ="ow "> and</ span > < span class =" ow " > not </ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> adapt_engaged</ span > < span class ="p "> :</ span >
315+ < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> iter_warmup</ span > < span class ="o "> == </ span > < span class ="mi "> 0</ span > < span class ="ow "> and</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> adapt_engaged</ span > < span class ="p "> :</ span >
312316 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span >
313- < span class ="s1 "> 'Argument "adapt_engaged" is False, '</ span >
314- < span class ="s1 "> 'cannot specify warmup iterations.'</ span >
317+ < span class ="s1 "> 'Must specify iter_warmup > 0 when adapt_engaged=True.'</ span >
315318 < span class ="p "> )</ span >
316319 < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> iter_sampling</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
317320 < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> iter_sampling</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="ow "> or</ span > < span class ="ow "> not</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span >
@@ -710,6 +713,8 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
710713 < span class ="n "> num_draws</ span > < span class ="p "> :</ span > < span class ="n "> Optional</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
711714 < span class ="n "> num_elbo_draws</ span > < span class ="p "> :</ span > < span class ="n "> Optional</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
712715 < span class ="n "> save_single_paths</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
716+ < span class ="n "> psis_resample</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
717+ < span class ="n "> calculate_lp</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
713718 < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
714719 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> init_alpha</ span > < span class ="o "> =</ span > < span class ="n "> init_alpha</ span >
715720 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> tol_obj</ span > < span class ="o "> =</ span > < span class ="n "> tol_obj</ span >
@@ -726,6 +731,8 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
726731 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> num_elbo_draws</ span > < span class ="o "> =</ span > < span class ="n "> num_elbo_draws</ span >
727732
728733 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> save_single_paths</ span > < span class ="o "> =</ span > < span class ="n "> save_single_paths</ span >
734+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> psis_resample</ span > < span class ="o "> =</ span > < span class ="n "> psis_resample</ span >
735+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> calculate_lp</ span > < span class ="o "> =</ span > < span class ="n "> calculate_lp</ span >
729736
730737< div class ="viewcode-block " id ="PathfinderArgs.validate "> < a class ="viewcode-back " href ="../../internal_api.html#cmdstanpy.cmdstan_args.PathfinderArgs.validate "> [docs]</ a > < span class ="k "> def</ span > < span class ="nf "> validate</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> _chains</ span > < span class ="p "> :</ span > < span class ="n "> Optional</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
731738< span class ="w "> </ span > < span class ="sd "> """</ span >
@@ -778,6 +785,12 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
778785 < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> save_single_paths</ span > < span class ="p "> :</ span >
779786 < span class ="n "> cmd</ span > < span class ="o "> .</ span > < span class ="n "> append</ span > < span class ="p "> (</ span > < span class ="s1 "> 'save_single_paths=1'</ span > < span class ="p "> )</ span >
780787
788+ < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> psis_resample</ span > < span class ="p "> :</ span >
789+ < span class ="n "> cmd</ span > < span class ="o "> .</ span > < span class ="n "> append</ span > < span class ="p "> (</ span > < span class ="s1 "> 'psis_resample=0'</ span > < span class ="p "> )</ span >
790+
791+ < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> calculate_lp</ span > < span class ="p "> :</ span >
792+ < span class ="n "> cmd</ span > < span class ="o "> .</ span > < span class ="n "> append</ span > < span class ="p "> (</ span > < span class ="s1 "> 'calculate_lp=0'</ span > < span class ="p "> )</ span >
793+
781794 < span class ="k "> return</ span > < span class ="n "> cmd</ span > </ div > </ div >
782795
783796
@@ -1037,8 +1050,8 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
10371050 < span class ="p "> )</ span >
10381051
10391052 < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
1040- < span class ="n "> rng</ span > < span class ="o "> =</ span > < span class ="n "> RandomState </ span > < span class ="p "> ()</ span >
1041- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> =</ span > < span class ="n "> rng</ span > < span class ="o "> .</ span > < span class ="n "> randint </ span > < span class ="p "> (</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="mi "> 99999</ span > < span class ="o " > + </ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span >
1053+ < span class ="n "> rng</ span > < span class ="o "> =</ span > < span class ="n "> default_rng </ span > < span class ="p "> ()</ span >
1054+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> =</ span > < span class ="n "> rng</ span > < span class ="o "> .</ span > < span class ="n "> integers </ span > < span class ="p "> (</ span > < span class ="n " > low </ span > < span class =" o " > = </ span > < span class =" mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n " > high </ span > < span class =" o " > = </ span > < span class =" mi "> 99999</ span > < span class =" p " > , </ span > < span class ="n " > size </ span > < span class =" o " > = </ span > < span class ="mi "> 1</ span > < span class ="p "> ) </ span > < span class =" o " > . </ span > < span class =" n " > item </ span > < span class =" p " > ( )</ span >
10421055 < span class ="k "> else</ span > < span class ="p "> :</ span >
10431056 < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="p "> ,</ span > < span class ="p "> (</ span > < span class ="nb "> int</ span > < span class ="p "> ,</ span > < span class ="nb "> list</ span > < span class ="p "> ,</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> integer</ span > < span class ="p "> )):</ span >
10441057 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span >
@@ -1177,9 +1190,8 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
11771190 </ div >
11781191 </ div >
11791192
1180- <!-- Scripts loaded after <body> so the DOM is not blocked -->
1181- < script src ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf "> </ script >
1182- < footer class ="footer mt-5 mt-md-0 ">
1193+ < script src ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf "> </ script >
1194+ < footer class ="footer mt-5 mt-md-0 ">
11831195 < div class ="container ">
11841196
11851197 < div class ="footer-item ">
@@ -1190,7 +1202,7 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
11901202
11911203 < div class ="footer-item ">
11921204 < p class ="sphinx-version ">
1193- Created using < a href ="http://sphinx-doc.org/ "> Sphinx</ a > 4.5 .0.< br >
1205+ Created using < a href ="http://sphinx-doc.org/ "> Sphinx</ a > 5.3 .0.< br >
11941206</ p >
11951207 </ div >
11961208
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments