pyro-ppl/pyro

Call for User-Contributed Examples and Tutorials!

Open

#1461 opened on Oct 17, 2018

View on GitHub
 (24 comments) (13 reactions) (0 assignees)Python (8,211 stars) (981 forks)batch import
Examplesdocumentationgood first issuehelp wanted

Description

Goal

Add creative examples of Pyro code developed by users out in the real world to our catalog of examples and tutorials. This is great for the community as a whole and helps the Pyro dev team focus on features that are useful to you and the broader community.

Context

The Pyro dev team met a bunch of Pyro users at ProbProg 2018 and heard about a variety of interesting applications of Pyro.

What is being asked

We realize that writing a clean piece of code that can be read by and is useful to a wide audience is difficult. We are also aware that some code/data cannot easily be made public. Wherever possible we are eager to help you overcome some of these potential barriers by

  • helping you clean up and comment your contributed code (and possibly add CUDA support)
  • help you find alternative datasets when needed
  • help you extract a smaller example of Pyro usage from a larger context

Who?

Anyone reading this!

Contributor guide

Tech stack
pythonpytorch
Domain
machine learningdocumentation
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.
1-2 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.
mostly clear
Prerequisites
Basic knowledge of PyroPython proficiencyFamiliarity with PyTorch
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Contributors should review existing Pyro examples and tutorials in the repository to understand the style and requirements. They can then propose a new example by opening a pull request or discussing in the issue. The Pyro dev team offers to help clean up code and find alternative datasets if needed.