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.0.8 documentation</ title >
8
+ < title > cmdstanpy.stanfit.metadata — CmdStanPy 1.1.0rc1 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.0.8 </ a >
59
+ < a class ='navbar-brand ' href ='../../../index.html '> CmdStanPy 1.1.0rc1 </ a >
60
60
61
61
</ div >
62
62
@@ -176,14 +176,14 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
176
176
177
177
178
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 >
179
- < span class ="sd "> """</ span >
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 >
182
182
< span class ="sd "> Assumes valid CSV files.</ span >
183
183
< span class ="sd "> """</ span >
184
184
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
- < span class ="sd "> """Initialize object from CSV headers"""</ span >
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
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
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 >
@@ -198,7 +198,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
198
198
199
199
< span class ="nd "> @property</ span >
200
200
< span class ="k "> def</ span > < span class ="nf "> cmdstan_config</ 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 "> Any</ span > < span class ="p "> ]:</ span >
201
- < span class ="sd "> """</ span >
201
+ < span class =" w " > </ span > < span class ="sd "> """</ span >
202
202
< span class ="sd "> Returns a dictionary containing a set of name, value pairs</ span >
203
203
< span class ="sd "> parsed out of the Stan CSV file header. These include the</ span >
204
204
< span class ="sd "> command configuration and the CSV file header row information.</ span >
@@ -208,7 +208,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
208
208
209
209
< span class ="nd "> @property</ span >
210
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 ="sd "> """</ span >
211
+ < span class =" w " > </ span > < span class ="sd "> """</ span >
212
212
< span class ="sd "> Returns a map from a Stan inference method variable to</ span >
213
213
< span class ="sd "> a tuple of column indices in inference engine's output array.</ span >
214
214
< span class ="sd "> Method variable names always end in `__`, e.g. `lp__`.</ span >
@@ -218,7 +218,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
218
218
219
219
< span class ="nd "> @property</ span >
220
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 ="sd "> """</ span >
221
+ < span class =" w " > </ span > < span class ="sd "> """</ span >
222
222
< span class ="sd "> Returns a map from a Stan program variable name to a</ span >
223
223
< span class ="sd "> tuple of the column indices in the vector or matrix of</ span >
224
224
< span class ="sd "> estimates produced by a CmdStan inference method.</ span >
@@ -228,7 +228,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
228
228
229
229
< span class ="nd "> @property</ span >
230
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 >
231
- < span class ="sd "> """</ span >
231
+ < span class =" w " > </ span > < span class ="sd "> """</ span >
232
232
< span class ="sd "> Returns map from Stan program variable names to variable dimensions.</ span >
233
233
< span class ="sd "> Scalar types are mapped to the empty tuple, e.g.,</ span >
234
234
< span class ="sd "> program variable ``int foo`` has dimension ``()`` and</ span >
@@ -239,7 +239,7 @@ <h1>Source code for cmdstanpy.stanfit.metadata</h1><div class="highlight"><pre>
239
239
240
240
< span class ="nd "> @property</ span >
241
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 ="sd "> """</ span >
242
+ < span class =" w " > </ span > < span class ="sd "> """</ span >
243
243
< span class ="sd "> Returns map from Stan program variable names to variable base type.</ span >
244
244
< span class ="sd "> Uses deepcopy for immutability.</ span >
245
245
< span class ="sd "> """</ span >
0 commit comments