Broad checklist of docs bits to work on
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- julia
- Domain
- documentation
Research direction
Review the Turing.jl documentation and tutorials, then use the unchecked condition/decondition, LogDensityProblems.jl interface, and DynamicPPL.TestUtils entries as the initial scope. Done means documenting those listed user-facing and developer-facing features and improving the tutorials, but the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Description
The documentation, in particular the one in Turing.jl itself, is in dire need of update given the amount of features and improvements we've made over the past year. In particular, the tutorials have lots and lots room for improvement.
A few things that come to mind immediately are the foollowing.
User-facing side:
-
Turing.predictfor predicting based on a givenchain. -
DynamicPPL.generated_quantities, similar to Stan's generated-block, which allows you to, effectively, capture the return-values of the model (i.e. the stuff inreturn ...) conditioned on achain. -
conditionanddecondition. There are now two ways to indicate whether a variable is to be considered an observation: passing the variable as an argument (the "old" way), or usingcondition/|(the "new" way). The latter has is, arguably, more intuitive, in addition to being much easier to work with programmatically. -
@submodel. A macro that allows you to use models within models. Makes it very easy to write modular models. -
logprior,loglikelihood, andlogjoint. Easy-to-use methods for evaluating the model in different ways. - fix and condition
Developer-side:
- Implementation of the LogDensityProblems.jl interface for a
@model. -
DynamicPPL.TestUtils. This is a sub-module of DynamicPPL that can be quite useful if one is developing features for Turing.
We will add more to the list as we go on, but for now this is a good starting point.
- Dominant language
- Markdown
- Stars
- 238
- Forks
- 107
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from TuringLang/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
TuringLang/docs#699 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
TuringLang/docs#700 ·
-
Update Callbacks docs and add examples of TensorBoard callbacksMay be free again @shravanngoswamii claimed this 157 days ago, and no pull request is open. Open
TuringLang/docs#686 · 1 assignee ·
-
try building with Julia 1.12May be free again @shravanngoswamii claimed this 83 days ago, and no pull request is open. Open
TuringLang/docs#684 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
TuringLang/docs#681 · 7 comments ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
pyca/verified-garbage#1023 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
quickemu-project/quickemu#1960 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
area/docs
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day