5
5
< head >
6
6
< meta charset ="utf-8 " />
7
7
< meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
8
- < title > cmdstanpy.stanfit.metadata — CmdStanPy 1.1 .0 documentation</ title >
8
+ < title > cmdstanpy.stanfit.metadata — CmdStanPy 1.2 .0 documentation</ title >
9
9
10
10
<!-- Loaded before other Sphinx assets -->
11
11
< link href ="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf " rel ="stylesheet ">
56
56
< div id ="navbar-start ">
57
57
58
58
<!-- This will display the version of the docs -->
59
- < a class ='navbar-brand ' href ='../../../index.html '> CmdStanPy 1.1 .0</ a >
59
+ < a class ='navbar-brand ' href ='../../../index.html '> CmdStanPy 1.2 .0</ a >
60
60
61
61
</ div >
62
62
@@ -170,12 +170,12 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
170
170
< span > </ span > < span class ="sd "> """Container for metadata parsed from the output of a CmdStan run"""</ span >
171
171
172
172
< span class ="kn "> import</ span > < span class ="nn "> copy</ span >
173
- < 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 " > Tuple </ span >
173
+ < 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 >
174
174
175
- < span class ="kn "> from </ span > < span class ="nn "> cmdstanpy.utils </ span > < span class =" kn " > import </ span > < span class =" n " > BaseType </ span > < span class =" p " > , </ span > < span class =" n " > parse_method_vars </ span > < span class =" p " > , </ span > < span class =" n " > parse_stan_vars </ span >
175
+ < span class ="kn "> import </ span > < span class ="nn "> stanio </ span >
176
176
177
177
178
- < div class ="viewcode-block " id ="InferenceMetadata "> < a class ="viewcode-back " href ="../../../internal_api.html#cmdstanpy.InferenceMetadata "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> InferenceMetadata</ span > < span class ="p "> :</ span >
178
+ < div class ="viewcode-block " id ="InferenceMetadata "> < a class ="viewcode-back " href ="../../../internal_api.html#cmdstanpy.stanfit. InferenceMetadata "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> InferenceMetadata</ span > < span class ="p "> :</ span >
179
179
< span class ="w "> </ span > < span class ="sd "> """</ span >
180
180
< span class ="sd "> CmdStan configuration and contents of output file parsed out of</ span >
181
181
< span class ="sd "> the Stan CSV file header comments and column headers.</ span >
@@ -185,13 +185,14 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
185
185
< span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> config</ span > < span class ="p "> :</ span > < span class ="n "> Dict</ 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 ="o "> -></ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
186
186
< span class ="w "> </ span > < span class ="sd "> """Initialize object from CSV headers"""</ span >
187
187
< span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _cmdstan_config</ span > < span class ="o "> =</ span > < span class ="n "> config</ span >
188
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _method_vars_cols</ span > < span class ="o "> =</ span > < span class ="n "> parse_method_vars</ span > < span class ="p "> (</ span > < span class ="n "> names</ span > < span class ="o "> =</ span > < span class ="n "> config</ span > < span class ="p "> [</ span > < span class ="s1 "> 'column_names'</ span > < span class ="p "> ])</ span >
189
- < span class ="n "> stan_vars_dims</ span > < span class ="p "> ,</ span > < span class ="n "> stan_vars_cols</ span > < span class ="p "> ,</ span > < span class ="n "> stan_vars_types</ span > < span class ="o "> =</ span > < span class ="n "> parse_stan_vars</ span > < span class ="p "> (</ span >
190
- < span class ="n "> names</ span > < span class ="o "> =</ span > < span class ="n "> config</ span > < span class ="p "> [</ span > < span class ="s1 "> 'column_names'</ span > < span class ="p "> ]</ span >
191
- < span class ="p "> )</ span >
192
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_dims</ span > < span class ="o "> =</ span > < span class ="n "> stan_vars_dims</ span >
193
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_cols</ span > < span class ="o "> =</ span > < span class ="n "> stan_vars_cols</ span >
194
- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_types</ span > < span class ="o "> =</ span > < span class ="n "> stan_vars_types</ span >
188
+ < span class ="nb "> vars</ span > < span class ="o "> =</ span > < span class ="n "> stanio</ span > < span class ="o "> .</ span > < span class ="n "> parse_header</ span > < span class ="p "> (</ span > < span class ="n "> config</ span > < span class ="p "> [</ span > < span class ="s1 "> 'raw_header'</ span > < span class ="p "> ])</ span >
189
+
190
+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _method_vars</ span > < span class ="o "> =</ span > < span class ="p "> {</ span >
191
+ < span class ="n "> k</ span > < span class ="p "> :</ span > < span class ="n "> v</ span > < span class ="k "> for</ span > < span class ="p "> (</ span > < span class ="n "> k</ span > < span class ="p "> ,</ span > < span class ="n "> v</ span > < span class ="p "> )</ span > < span class ="ow "> in</ span > < span class ="nb "> vars</ span > < span class ="o "> .</ span > < span class ="n "> items</ span > < span class ="p "> ()</ span > < span class ="k "> if</ span > < span class ="n "> k</ span > < span class ="o "> .</ span > < span class ="n "> endswith</ span > < span class ="p "> (</ span > < span class ="s1 "> '__'</ span > < span class ="p "> )</ span >
192
+ < span class ="p "> }</ span >
193
+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars</ span > < span class ="o "> =</ span > < span class ="p "> {</ span >
194
+ < span class ="n "> k</ span > < span class ="p "> :</ span > < span class ="n "> v</ span > < span class ="k "> for</ span > < span class ="p "> (</ span > < span class ="n "> k</ span > < span class ="p "> ,</ span > < span class ="n "> v</ span > < span class ="p "> )</ span > < span class ="ow "> in</ span > < span class ="nb "> vars</ span > < span class ="o "> .</ span > < span class ="n "> items</ span > < span class ="p "> ()</ span > < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="n "> k</ span > < span class ="o "> .</ span > < span class ="n "> endswith</ span > < span class ="p "> (</ span > < span class ="s1 "> '__'</ span > < span class ="p "> )</ span >
195
+ < span class ="p "> }</ span >
195
196
196
197
< span class ="k "> def</ span > < span class ="fm "> __repr__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb "> str</ span > < span class ="p "> :</ span >
197
198
< span class ="k "> return</ span > < span class ="s1 "> 'Metadata:</ span > < span class ="se "> \n</ span > < span class ="si "> {}</ span > < span class ="se "> \n</ 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 "> _cmdstan_config</ span > < span class ="p "> )</ span >
@@ -207,43 +208,18 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
207
208
< span class ="k "> return</ span > < span class ="n "> copy</ span > < span class ="o "> .</ span > < span class ="n "> deepcopy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _cmdstan_config</ span > < span class ="p "> )</ span >
208
209
209
210
< span class ="nd "> @property</ span >
210
- < span class ="k "> def</ span > < span class ="nf "> method_vars_cols </ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> Tuple </ span > < span class ="p " > [ </ span > < span class ="nb " > int </ span > < span class ="p "> , </ span > < span class =" o " > ... </ span > < span class =" p " > ] ]:</ span >
211
+ < span class ="k "> def</ span > < span class ="nf "> method_vars </ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> stanio </ span > < span class ="o " > . </ span > < span class ="n " > Variable </ span > < span class ="p "> ]:</ span >
211
212
< span class ="w "> </ span > < span class ="sd "> """</ span >
212
- < span class ="sd "> Returns a map from a Stan inference method variable to</ span >
213
- < span class ="sd "> a tuple of column indices in inference engine's output array.</ span >
214
213
< span class ="sd "> Method variable names always end in `__`, e.g. `lp__`.</ span >
215
- < span class ="sd "> Uses deepcopy for immutability.</ span >
216
- < span class ="sd "> """</ span >
217
- < span class ="k "> return</ span > < span class ="n "> copy</ span > < span class ="o "> .</ span > < span class ="n "> deepcopy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _method_vars_cols</ span > < span class ="p "> )</ span >
218
-
219
- < span class ="nd "> @property</ span >
220
- < span class ="k "> def</ span > < span class ="nf "> stan_vars_cols</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> Tuple</ span > < span class ="p "> [</ span > < span class ="nb "> int</ span > < span class ="p "> ,</ span > < span class ="o "> ...</ span > < span class ="p "> ]]:</ span >
221
- < span class ="w "> </ span > < span class ="sd "> """</ span >
222
- < span class ="sd "> Returns a map from a Stan program variable name to a</ span >
223
- < span class ="sd "> tuple of the column indices in the vector or matrix of</ span >
224
- < span class ="sd "> estimates produced by a CmdStan inference method.</ span >
225
- < span class ="sd "> Uses deepcopy for immutability.</ span >
226
214
< span class ="sd "> """</ span >
227
- < span class ="k "> return</ span > < span class ="n " > copy </ span > < span class =" o " > . </ span > < span class =" n " > deepcopy </ span > < span class =" p " > ( </ span > < span class =" bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_cols </ span > < span class =" p " > ) </ span >
215
+ < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _method_vars </ span >
228
216
229
217
< span class ="nd "> @property</ span >
230
- < span class ="k "> def</ span > < span class ="nf "> stan_vars_dims </ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> Tuple </ span > < span class ="p " > [ </ span > < span class ="nb " > int </ span > < span class ="p "> , </ span > < span class =" o " > ... </ span > < span class =" p " > ] ]:</ span >
218
+ < span class ="k "> def</ span > < span class ="nf "> stan_vars </ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> stanio </ span > < span class ="o " > . </ span > < span class ="n " > Variable </ span > < span class ="p "> ]:</ span >
231
219
< span class ="w "> </ span > < span class ="sd "> """</ span >
232
- < span class ="sd "> Returns map from Stan program variable names to variable dimensions.</ span >
233
- < span class ="sd "> Scalar types are mapped to the empty tuple, e.g.,</ span >
234
- < span class ="sd "> program variable ``int foo`` has dimension ``()`` and</ span >
235
- < span class ="sd "> program variable ``vector[10] bar`` has single dimension ``(10)``.</ span >
236
- < span class ="sd "> Uses deepcopy for immutability.</ span >
237
- < span class ="sd "> """</ span >
238
- < span class ="k "> return</ span > < span class ="n "> copy</ span > < span class ="o "> .</ span > < span class ="n "> deepcopy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_dims</ span > < span class ="p "> )</ span >
239
-
240
- < span class ="nd "> @property</ span >
241
- < span class ="k "> def</ span > < span class ="nf "> stan_vars_types</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> BaseType</ span > < span class ="p "> ]:</ span >
242
- < span class ="w "> </ span > < span class ="sd "> """</ span >
243
- < span class ="sd "> Returns map from Stan program variable names to variable base type.</ span >
244
- < span class ="sd "> Uses deepcopy for immutability.</ span >
220
+ < span class ="sd "> These are the user-defined variables in the Stan program.</ span >
245
221
< span class ="sd "> """</ span >
246
- < span class ="k "> return</ span > < span class ="n " > copy </ span > < span class =" o " > . </ span > < span class =" n " > deepcopy </ span > < span class =" p " > ( </ span > < span class =" bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars_types </ span > < span class =" p " > ) </ span > </ div >
222
+ < span class ="k "> return</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _stan_vars </ span > </ div >
247
223
</ pre > </ div >
248
224
249
225
</ div >
@@ -266,7 +242,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
266
242
267
243
< div class ="footer-item ">
268
244
< p class ="copyright ">
269
- © Copyright 2022 , Stan Development Team.< br >
245
+ © Copyright 2023 , Stan Development Team.< br >
270
246
</ p >
271
247
</ div >
272
248
0 commit comments