Skip to content

Commit 933c4cf

Browse files
authored
Merge pull request #635 from stan-dev/fix/laplace-output-docs
Update laplace output documentation
2 parents 411074f + fba94e7 commit 933c4cf

6 files changed

Lines changed: 30 additions & 33 deletions

File tree

docs/2_32/cmdstan-guide-2_32.pdf

-39 Bytes
Binary file not shown.

docs/2_32/cmdstan-guide/laplace-sampling.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -425,13 +425,12 @@ <h2><span class="header-section-number">13.1</span> Configuration</h2>
425425
<h2><span class="header-section-number">13.2</span> CSV output</h2>
426426
<p>The output file consists of the following pieces of information:</p>
427427
<ul>
428-
<li><p>The full set of configuration options available for the <code>log_prob</code> method is
428+
<li><p>The full set of configuration options available for the <code>laplace</code> method is
429429
reported at the beginning of the output file as CSV comments.</p></li>
430-
<li><p>Output columns for all model parameters on the constrained scale,
431-
followed by columns <code>log_p</code> and <code>log_q</code>,
432-
the unnormalized log density and the unnormalized density of the
433-
Laplace approximation, respectively.
430+
<li><p>Output columns <code>log_p__</code> and <code>log_q__</code>, the unnormalized log density and the
431+
unnormalized density of the Laplace approximation, respectively.
434432
These can be used for diagnostics and importance sampling.</p></li>
433+
<li><p>Output columns for all model parameters on the constrained scale.</p></li>
435434
</ul>
436435
</div>
437436
<div id="example" class="section level2" number="13.3">
@@ -479,11 +478,11 @@ <h2><span class="header-section-number">13.3</span> Example</h2>
479478
# profile_file = profile.csv (Default)
480479
# num_threads = 1 (Default)
481480
# stanc_version = stanc3 v2.31.0-7-g20444266
482-
# stancflags =
483-
theta,log_p,log_q
484-
0.0498545,-9.4562,-2.33997
485-
0.182898,-6.9144,-0.0117349
486-
0.376428,-7.18171,-0.746034
481+
# stancflags =
482+
log_p__,log_q__,theta
483+
-9.4562,-2.33997,0.0498545
484+
-6.9144,-0.0117349,0.182898
485+
-7.18171,-0.746034,0.376428
487486
...</code></pre>
488487

489488
</div>

docs/2_32/cmdstan-guide/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/cmdstan-guide/laplace-sampling.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -425,13 +425,12 @@ <h2><span class="header-section-number">13.1</span> Configuration</h2>
425425
<h2><span class="header-section-number">13.2</span> CSV output</h2>
426426
<p>The output file consists of the following pieces of information:</p>
427427
<ul>
428-
<li><p>The full set of configuration options available for the <code>log_prob</code> method is
428+
<li><p>The full set of configuration options available for the <code>laplace</code> method is
429429
reported at the beginning of the output file as CSV comments.</p></li>
430-
<li><p>Output columns for all model parameters on the constrained scale,
431-
followed by columns <code>log_p</code> and <code>log_q</code>,
432-
the unnormalized log density and the unnormalized density of the
433-
Laplace approximation, respectively.
430+
<li><p>Output columns <code>log_p__</code> and <code>log_q__</code>, the unnormalized log density and the
431+
unnormalized density of the Laplace approximation, respectively.
434432
These can be used for diagnostics and importance sampling.</p></li>
433+
<li><p>Output columns for all model parameters on the constrained scale.</p></li>
435434
</ul>
436435
</div>
437436
<div id="example" class="section level2" number="13.3">
@@ -479,11 +478,11 @@ <h2><span class="header-section-number">13.3</span> Example</h2>
479478
# profile_file = profile.csv (Default)
480479
# num_threads = 1 (Default)
481480
# stanc_version = stanc3 v2.31.0-7-g20444266
482-
# stancflags =
483-
theta,log_p,log_q
484-
0.0498545,-9.4562,-2.33997
485-
0.182898,-6.9144,-0.0117349
486-
0.376428,-7.18171,-0.746034
481+
# stancflags =
482+
log_p__,log_q__,theta
483+
-9.4562,-2.33997,0.0498545
484+
-6.9144,-0.0117349,0.182898
485+
-7.18171,-0.746034,0.376428
487486
...</code></pre>
488487

489488
</div>

docs/cmdstan-guide/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

src/cmdstan-guide/laplace_sample_config.Rmd

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ method default setting, `jacobian=1`, should be used.
4040

4141
The output file consists of the following pieces of information:
4242

43-
- The full set of configuration options available for the `log_prob` method is
43+
- The full set of configuration options available for the `laplace` method is
4444
reported at the beginning of the output file as CSV comments.
4545

46-
- Output columns for all model parameters on the constrained scale,
47-
followed by columns `log_p` and `log_q`,
48-
the unnormalized log density and the unnormalized density of the
49-
Laplace approximation, respectively.
46+
- Output columns `log_p__` and `log_q__`, the unnormalized log density and the
47+
unnormalized density of the Laplace approximation, respectively.
5048
These can be used for diagnostics and importance sampling.
5149

50+
- Output columns for all model parameters on the constrained scale.
51+
5252
## Example
5353

5454
To get an approximate estimate of the mode and standard deviation of the
@@ -102,11 +102,10 @@ The header and first few data rows of the output sample are shown below.
102102
# profile_file = profile.csv (Default)
103103
# num_threads = 1 (Default)
104104
# stanc_version = stanc3 v2.31.0-7-g20444266
105-
# stancflags =
106-
theta,log_p,log_q
107-
0.0498545,-9.4562,-2.33997
108-
0.182898,-6.9144,-0.0117349
109-
0.376428,-7.18171,-0.746034
105+
# stancflags =
106+
log_p__,log_q__,theta
107+
-9.4562,-2.33997,0.0498545
108+
-6.9144,-0.0117349,0.182898
109+
-7.18171,-0.746034,0.376428
110110
...
111111
```
112-

0 commit comments

Comments
 (0)