question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Write "Working with InferenceData" page

See original GitHub issue

Tell us about it

As part of the documentation revamp described in #1331. We should add a page explaining how to work with InferenceData and show several common tasks. The guide should cover at least the following topics:

#1506

  • Stacking dimensions (maybe even reshaping? reshaping is a bit crazy though), fancy chain/draw extraction methods from #1469
  • Some grouping/aggregating of data: mean
  • Get values and coordinates as arrays
  • Slice inferenceData objects

Pending

  • modifying, transforming and/or creating a variable within an InferenceData group or groups. See #641 for code examples that can be used for this
  • how to combine/merge/extend multiple InferenceData objects
  • Coordinate modification. Maybe something like #1461 (includes example code and explanation)

Thoughts on implementation

Feel free to tackle parts of the issue instead of generating the whole section at once.

It is also probably a good idea to add a See also section at the bottom linking to other docs (i.e. pymc3 or pystan docs), blogs and other resources that use inferencedata. For example: https://docs.pymc.io/notebooks/multilevel_modeling.html

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:19 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
mjhajhariacommented, Apr 28, 2021

@OriolAbril Hi! I’m sorry for replying so late, I’m alright mentally and physically now so I’m free to get back to contributing!!! Um I think I’ll make a draft PR with very basic changes and whatever I feel might work, and from thereon you can suggest redirections or changes, does that sound good?

1reaction
OriolAbrilcommented, Apr 14, 2021

Following the documentation system in https://diataxis.fr/ (they just changed the url, but it’s the same content I linked to above), docs are not supposed to be all over the place but should be separate at least into 4 different pages. InferenceData docs are actually close to getting there, but we need to also make sure each page is clear on what is explained in them and has links to the other pages in case the info is not in that page but in another one (this last part is a bit of a disaster right now).

A very quick summary of diataxis (from its own introduction page):

| Tutorials | How-to guides | Reference | Explanation – | – | – | – | – oriented to | learning | a goal | information | understanding must | allow the newcomer to get started | show how to solve a specific problem | describe the machinery | explain its form | a lesson | a series of steps | dry description | discursive explanation analogy | teaching a small child how to cook | a recipe in a cookery book | a reference encyclopaedia article | an article on culinary social history for InferenceData | Working with InferenceData page (in getting started section) | unclear, maybe some page in the user guide secion, maybe links to case studies in pymc/stan/… docs (i.e. radon or rugby examples) | InferenceData schema | XarrayforArviZ |

the InferenceData schema is dry and is not a good resource to understand InferenceData: why it’s useful?, why is it needed?, what are it’s main (and super cool) features); but it should not be. It’s goal is to describe InferenceData in an encycopedic-like manner.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Creating InferenceData — ArviZ dev documentation
InferenceData is the central data format for ArviZ. InferenceData itself is just a container that maintains references to one or more xarray.Dataset s....
Read more >
Working with InferenceData — ArviZ 0.14.0 documentation
In this page we print DataArrays and Datasets several times and they always ... Working with InferenceData is working mainly with xarray objects...
Read more >
Inference — PyMC3 3.11.5 documentation
A MultiTrace or ArviZ InferenceData object that contains the samples. ... Higher values like 0.9 or 0.95 often work better for problematic posteriors....
Read more >
Common Data Formats for Inference - Amazon SageMaker
Convert Data for Inference Request Serialization. Content type options for Amazon SageMaker algorithm inference requests include: text/csv , application/json , ...
Read more >
module 'pymc3' has no attribute 'traceplot' Error
PyMC3 is transitioning to using InferenceData as default output of ... Working with InferenceData examples (shows how to perform burn-in ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found