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.0.1 documentation</ title >
8+ < title > cmdstanpy.cmdstan_args — CmdStanPy 1.0.2 documentation</ title >
99
10- < link href ="../../_static/styles/theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
10+ <!-- Loaded before other Sphinx assets -->
11+ < link href ="../../_static/styles/theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
1112< link href ="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf " 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-
13+
2414
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+
2522 < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css " />
2623 < link rel ="stylesheet " type ="text/css " href ="../../_static/css/project-template.css " />
2724 < link rel ="stylesheet " type ="text/css " href ="../../_static/copybutton.css " />
2825
29- < link rel ="preload " as ="script " href ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf ">
30-
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+
3129 < script data-url_root ="../../ " id ="documentation_options " src ="../../_static/documentation_options.js "> </ script >
3230 < script src ="../../_static/jquery.js "> </ script >
3331 < script src ="../../_static/underscore.js "> </ script >
4745< link rel ="stylesheet " href ="_static/basic.css " type ="text/css " />
4846
4947 </ head >
50- < body data-spy ="scroll " data-target ="#bd-toc-nav " data-offset ="80 ">
48+ < body data-spy ="scroll " data-target ="#bd-toc-nav " data-offset ="60 ">
5149
5250 < div class ="container-fluid " id ="banner "> </ div >
5351
5856 < div id ="navbar-start ">
5957
6058 <!-- This will display the version of the docs -->
61- < a class ='navbar-brand ' href ='index.html '> CmdStanPy 1.0.1 </ a >
59+ < a class ='navbar-brand ' href ='index.html '> CmdStanPy 1.0.2 </ a >
6260
6361 </ div >
6462
8684
8785< li class ="toctree-l1 nav-item ">
8886 < a class ="reference internal nav-link " href ="../../hello_world.html ">
89- “Hello, World”
87+ “Hello, World! ”
9088 </ a >
9189</ li >
9290
102100 </ a >
103101</ li >
104102
103+ < li class ="toctree-l1 nav-item ">
104+ < a class ="reference internal nav-link " href ="../../community.html ">
105+ Community
106+ </ a >
107+ </ li >
108+
105109< li class ="toctree-l1 nav-item ">
106110 < a class ="reference internal nav-link " href ="../../api.html ">
107111 API Reference
@@ -183,6 +187,8 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
183187 < span class ="n "> write_stan_json</ span > < span class ="p "> ,</ span >
184188< span class ="p "> )</ span >
185189
190+ < span class ="n "> OptionalPath</ span > < span class ="o "> =</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> PathLike</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span >
191+
186192
187193< span class ="k "> class</ span > < span class ="nc "> Method</ span > < span class ="p "> (</ span > < span class ="n "> Enum</ span > < span class ="p "> ):</ span >
188194 < span class ="sd "> """Supported CmdStan method names."""</ span >
@@ -868,15 +874,15 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
868874 < span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span >
869875 < span class ="bp "> self</ span > < span class ="p "> ,</ span >
870876 < span class ="n "> model_name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span >
871- < span class ="n "> model_exe</ span > < span class ="p "> :</ span > < span class ="n "> Optional </ span > < span class ="p "> [ </ span > < span class =" nb " > str </ span > < span class =" p " > ] ,</ span >
872- < span class ="n "> chain_ids</ span > < span class ="p "> :</ span > < span class ="n "> Union </ span > < span class ="p "> [</ span > < span class ="n "> List</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ], </ span > < span class =" kc " > None </ span > < span class =" p " > ],</ span >
877+ < span class ="n "> model_exe</ span > < span class ="p "> :</ span > < span class ="n "> OptionalPath </ span > < span class ="p "> ,</ span >
878+ < span class ="n "> chain_ids</ span > < span class ="p "> :</ span > < span class ="n "> Optional </ span > < span class ="p "> [</ span > < span class ="n "> List</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ]],</ span >
873879 < span class ="n "> method_args</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span >
874880 < span class ="n "> SamplerArgs</ span > < span class ="p "> ,</ span > < span class ="n "> OptimizeArgs</ span > < span class ="p "> ,</ span > < span class ="n "> GenerateQuantitiesArgs</ span > < span class ="p "> ,</ span > < span class ="n "> VariationalArgs</ span >
875881 < span class ="p "> ],</ span >
876882 < span class ="n "> data</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="n "> Mapping</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> Any</ span > < span class ="p "> ],</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
877883 < span class ="n "> seed</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ,</ span > < span class ="n "> List</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ],</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
878884 < span class ="n "> inits</ span > < span class ="p "> :</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ,</ span > < span class ="nb "> float</ span > < span class ="p "> ,</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> List</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ],</ span > < span class ="kc "> None</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
879- < span class ="n "> output_dir</ span > < span class ="p "> :</ span > < span class ="n "> Optional </ span > < span class =" p " > [ </ span > < span class =" nb " > str </ span > < span class =" p " > ] </ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
885+ < span class ="n "> output_dir</ span > < span class ="p "> :</ span > < span class ="n "> OptionalPath </ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
880886 < span class ="n "> sig_figs</ 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 >
881887 < span class ="n "> save_latent_dynamics</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
882888 < span class ="n "> save_profile</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span >
@@ -992,7 +998,7 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
992998 < span class ="s1 "> '0 and 2**32-1, 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 "> seed</ span > < span class ="p "> )</ span >
993999 < span class ="p "> )</ span >
9941000 < span class ="k "> if</ 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 ="nb "> int</ span > < span class ="p "> ):</ span >
995- < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="ow "> or</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> ></ span > < span class ="mi "> 2</ span > < span class ="o "> **</ span > < span class ="mi "> 32</ span > < span class ="o "> -</ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
1001+ < span class ="k "> if</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="ow "> or</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="o "> ></ span > < span class ="mi "> 2</ span > < span class ="o "> **</ span > < span class ="mi "> 32</ span > < span class ="o "> -</ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
9961002 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span >
9971003 < span class ="s1 "> 'Argument "seed" must be an integer between '</ span >
9981004 < span class ="s1 "> '0 and 2**32-1, 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 "> seed</ span > < span class ="p "> )</ span >
@@ -1011,7 +1017,7 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
10111017 < span class ="p "> )</ span >
10121018 < span class ="p "> )</ span >
10131019 < span class ="k "> for</ span > < span class ="n "> seed</ span > < span class ="ow "> in</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> seed</ span > < span class ="p "> :</ span >
1014- < span class ="k "> if</ span > < span class ="n "> seed</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="ow "> or</ span > < span class ="n "> seed</ span > < span class ="o "> ></ span > < span class ="mi "> 2</ span > < span class ="o "> **</ span > < span class ="mi "> 32</ span > < span class ="o "> -</ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
1020+ < span class ="k "> if</ span > < span class ="n "> seed</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="ow "> or</ span > < span class ="n "> seed</ span > < span class ="o "> ></ span > < span class ="mi "> 2</ span > < span class ="o "> **</ span > < span class ="mi "> 32</ span > < span class ="o "> -</ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
10151021 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span >
10161022 < span class ="s1 "> 'Argument "seed" must be an integer value'</ span >
10171023 < span class ="s1 "> ' between 0 and 2**32-1,'</ span >
@@ -1122,8 +1128,9 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
11221128 </ div >
11231129 </ div >
11241130
1125- < script src ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf "> </ script >
1126- < footer class ="footer mt-5 mt-md-0 ">
1131+ <!-- Scripts loaded after <body> so the DOM is not blocked -->
1132+ < script src ="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf "> </ script >
1133+ < footer class ="footer mt-5 mt-md-0 ">
11271134 < div class ="container ">
11281135
11291136 < div class ="footer-item ">
@@ -1134,7 +1141,7 @@ <h1>Source code for cmdstanpy.cmdstan_args</h1><div class="highlight"><pre>
11341141
11351142 < div class ="footer-item ">
11361143 < p class ="sphinx-version ">
1137- Created using < a href ="http://sphinx-doc.org/ "> Sphinx</ a > 4.4 .0.< br >
1144+ Created using < a href ="http://sphinx-doc.org/ "> Sphinx</ a > 4.5 .0.< br >
11381145</ p >
11391146 </ div >
11401147
0 commit comments