TuringLang / TuringLang/AbstractMCMC.jl
Make `getstats` interface more specific
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 108
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
I'd hope we have more specific guidelines on how samplers should implement or use this API.
Originally posted by @yebai in https://github.com/TuringLang/AbstractMCMC.jl/pull/182#discussion_r2467194991
EDIT: It may be a good idea to deprecate getstats in favour of AbstractMCMC.ParamsWithStats.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the getstats discussion in pull request 182 and the AbstractMCMC.ParamsWithStats definition in src/callbacks.jl. Determine the intended sampler guidelines and whether getstats should be deprecated in favor of ParamsWithStats; done means the API direction and implementation scope are explicitly settled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100