Skip to content

Commit eb015c8

Browse files
Merge pull request #919 from amas0/master
Minor typos in pathfinder config
2 parents 9c474af + 6904ebe commit eb015c8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/cmdstan-guide/pathfinder_config.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ is available by using the `pathfinder help-all` subcommand. The arguments
2424
with their requested values or defaults are also reported at the beginning
2525
of the algorithm's console output and in the output CSV file's comments.
2626

27-
The following is a minimal call the Pathfinder algorithm using
27+
The following is a minimal call to the Pathfinder algorithm using
2828
defaults for everything but the location of the data file.
2929

3030
```
3131
> ./bernoulli pathfinder data file=bernoulli.data.R
3232
```
3333

34-
Executing this command prints both output to the console and csv files.
34+
Executing this command prints output both to the console and to csv files.
3535

3636
The first part of the console output reports on the configuration used.
3737
```
@@ -122,8 +122,8 @@ Valid values: `[true, false]`. Default is `true`.
122122
- `calculate_lp` - If `true`, log probabilities of the approximate draws
123123
are calculated and returned with the output. If `false`, each pathfinder
124124
will only calculate the lp values needed for the ELBO calculation.
125-
If False, PSIS resampling cannot be performed and the algorithm returns
126-
`num_paths * num_draws samples`. The output will still contain any lp values
125+
If `false`, PSIS resampling cannot be performed and the algorithm returns
126+
`num_paths * num_draws` samples. The output will still contain any lp values
127127
used when calculating ELBO scores within L-BFGS iterations.
128128
Valid values: `[true, false]`. Default is `true`.
129129

@@ -192,7 +192,7 @@ The final lines are comment lines which give timing information.
192192
Pathfinder provides option `save_single_paths` which will save output
193193
from the single-path Pathfinder runs.
194194

195-
## Single-path Pathfinder Outputs.
195+
## Single-path Pathfinder Outputs
196196

197197
The boolean option `save_single_paths` is used to save both the draws and the ELBO iterations from the individual Pathfinder runs.
198198
When `save_single_paths` is `true`, the draws from each are saved to
@@ -275,7 +275,7 @@ at each point along the trajectory of the L-BFGS optimization algorithms.
275275
}
276276
```
277277

278-
Option `num_paths=1` runs one single-path Pathfinder and output CSV file contains the draws from that run without PSIS reweighting.
278+
Option `num_paths=1` runs one single-path Pathfinder and the output CSV file contains the draws from that run without PSIS reweighting.
279279
The combination of arguments `num_paths=1 save_single_paths=true` creates just two output files,
280280
the CSV sample and the set of ELBO iterations.
281281
In this case, the default output file name is "output.csv" and the default diagnostic file name is "output.json".

0 commit comments

Comments
 (0)