pyro-ppl/pyro

Refactor SVI tutorial code from MD code blocks into code cells

Open

#2,714 opened on Dec 15, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (981 forks)batch import
Examplesgood first issuehelp wanted

Repository metrics

Stars
 (8,211 stars)
PR merge metrics
 (Avg merge 10d 19h) (1 merged PR in 30d)

Description

As it stands, a significant portion of the SVI tutorial code is written in markdown code blocks, rather than standalone Jupyter cells. When formatted this way, the tutorial's notebook cannot be excecuted and experimented with by the reader. I suggest that the markdown code blocks should be refactored into Jupyter code cells.

Contributor guide

Research direction
Open the notebook file, locate markdown code blocks containing Python code, convert them to code cells, and ensure the notebook runs correctly.
Tech stack
python
Domain
documentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
PythonJupyter Notebook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90