arviz-devs/arviz

Write conversion guides

Open

#1,489 opened on Jan 8, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TeX (495 forks)batch import
DiscussionHelp WantedUser Documentation

Repository metrics

Stars
 (1,818 stars)
PR merge metrics
 (Avg merge 3d 8h) (5 merged PRs in 30d)

Description

Tell us about it

Convert the cookbook into a collection of notebooks (one per PPL) with extended documentation on the respective converter function from_xyz. PPL tracker:

  • PyMC3 (if the examples below are good enough it's only a matter of putting the notebook together)
  • PyStan
  • CmdStanPy
  • Pyro
  • NumPyro
  • emcee (there are extensive examples in the from_emcee api docs that can help write this)
  • TensorFlow Probability

Thoughts on implementation

I think it would be great to define a set of tasks of increasing difficulty and then (if possible) show how to tackle them in each of the PPLs and how to convert the data to InferenceData. The current example in the cookbook is a possible starting point. The examples (click on the QR codes) for my ProbProg poster are a more complete example of InferenceData creation. And my pymc3-arviz blogpost could be used as intermediate examples.

Note: the cookbook would not be deleted, it would keep the numpy array, dict, dataframe... conversions

Contributor guide

Research direction
Start by reviewing the current cookbook and the linked resources (poster examples, blogpost). For each PPL, create a Jupyter notebook that shows how to use the corresponding `from xyz` function with example models. Use the existing `from emcee` API docs as a template.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50