pyro-ppl/pyro

Request for more masking tutorials

Open

#3187 opened on Mar 10, 2023

View on GitHub
 (13 comments) (4 reactions) (0 assignees)Python (8,211 stars) (981 forks)batch import
documentationhelp wantedusability

Description

Hi!

As discussed here https://forum.pyro.ai/t/more-doubts-on-masking-runnable-example/5044/6 and here https://forum.pyro.ai/t/vae-classification/5017/10, things might not be very clear on when and how to use the different masking options. Especially in defining differences in masking usage on the model vs guide. Or masking with enumeration

  • Explain the practical differences between all the masking options (poutine.mask, obs_mask, mask())
  • Usage example with VAE model-guide architecture (supervised, semi-supervised, unsupervised approaches)
  • How to use masks when there are event vs batch shapes
  • Usage with enumeration
  • Nested masks
  • Meaning of the "mask" in the trace. Why when i) using the context manager poutine.mask it shows under the "mask" in the trace the used mask tensor and when ii) using .mask() or obs_mask the "mask" of the trace shows "None".

Thanks! :)

Contributor guide

Tech stack
pythonpytorch
Domain
documentationmachine learning
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of Pyrounderstanding of probabilistic programmingfamiliarity with VAE
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review existing masking documentation in Pyro, particularly poutine.mask, obs mask, and mask() methods. Study the forum discussions referenced for clarification. Create tutorial notebooks covering each checklist item, including VAE examples and enumeration scenarios.