pyro icon indicating copy to clipboard operation
pyro copied to clipboard

Documentation requests (asking for a user)

Open fritzo opened this issue 2 years ago • 3 comments

  • [ ] It's unclear what all these concepts are: model, guide, poutine. Where's the man page for guide?
  • [ ] It would help to stratify tutorial into beginner, moderate, expert. I'm not sure where to start.

cc @HenryWard

fritzo avatar Aug 18 '22 19:08 fritzo

poutine has two pages: The man page seems to be located here. Additionally, there is more of a tutorial based page under the section "Understanding Pyro's internals".

guide is spread out in various tutorials, primarily in the sections Introductory Tutorials and in the Bayesian regression (part 1 and 2) in "Practical Pyro and PyTorch". It seems there is no dedicated man page.

model is defined in an Introduction to Pyro. Though, this is the only tutorial I could find describing the model and the related pyro primitives.

@HenryWard are you working on this? If not, I could give this issue a go.

GStechschulte avatar Oct 24 '22 13:10 GStechschulte

@GStechschulte contributions are welcome! I don't believe @HenryWard is working on this. If you do make a PR could you cc @eb8680 as he as thought a lot about how to present these concepts and would be a good reviewer.

fritzo avatar Oct 28 '22 03:10 fritzo

@GStechschulte please go for it, @fritzo is right that I will not be working on this

HenryWard avatar Oct 28 '22 13:10 HenryWard