stan-dev / stan-dev/docs

Add more in-depth description of Pathfinder to the reference-manual

Open
#751 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
43
Forks
133
Avg merge
11h 32m
Merged PRs (30d)
4

Description

The current page is at https://mc-stan.org/docs/reference-manual/pathfinder.html,
source: https://github.com/stan-dev/docs/blob/master/src/reference-manual/pathfinder.qmd

There is not currently a good description of the algorithmic tuning parameters or stages of the algorithm, especially compared to e.g. HMC at https://mc-stan.org/docs/reference-manual/mcmc.html

@bob-carpenter said he could do a pass on this

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Edit src/reference-manual/pathfinder.qmd, starting by comparing its current algorithm description with the HMC reference at https://mc-stan.org/docs/reference-manual/mcmc.html. Document Pathfinder's algorithmic tuning parameters and stages in more depth; the issue does not mention a specific test or validation command.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.