TuringLang / TuringLang/docs

Turing performance, debugging and benchmarks meta issue

Open
#700 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Markdown
Stars
238
Forks
107
Avg merge
1d 1h
Merged PRs (30d)
2

Description

Tracking issue for documentation on measuring and improving the performance of Turing models, and on debugging them. It collects the following:

  • TuringLang/docs#702 (better performance guidelines: benchmark and profile a model, choose an AD backend, write efficient models)
  • TuringLang/Turing.jl#564 (a page on debugging tools)
  • TuringLang/Turing.jl#565 (tips on optimising performance)
  • TuringLang/Turing.jl#668 (interpreting chain summary statistics and debugging MCMC)
What the docs cover today

Note that TuringBenchmarking.jl is deprecated. The current tool is DynamicPPL.TestUtils.AD.run_ad, which gives primal and gradient timings per backend.

Remaining work
  • Benchmarking and profiling guidance (Turing.jl#2414, TuringLang/Turing.jl#565)
  • A page on model debugging tools: check_model, model_warntype, and related utilities (#564)
  • Remove references to the archived ADTests site
  • A guide on interpreting chain summary statistics (ess, rhat, mcse) and diagnosing MCMC problems (#668)

The first three items are addressed by the linked PR. The last is a larger writing task and is left open here.

Contributor guide

Open the contributing guide

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

Start with Turing.jl#668 and review the existing Automatic Differentiation, Performance Tips, and Troubleshooting pages linked in this issue. Define the guide’s scope around interpreting ess, rhat, and mcse and diagnosing MCMC problems. Done means the remaining documentation task is covered with a clear, usable guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.