Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the documentation #236

Open
8 of 22 tasks
rlouf opened this issue Jun 29, 2022 · 1 comment
Open
8 of 22 tasks

Improve the documentation #236

rlouf opened this issue Jun 29, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rlouf
Copy link
Member

rlouf commented Jun 29, 2022 •
edited
Loading

The documentation is currently lacking, to say the least. Here is what a minimal working documentation looks like:

  • HOW TO
    • Metropolis-within-Gibbs
    • Sample loop
    • Multiple chains
    • Adaptation
    • Distribute gradient computation
    • PyMC
    • Aesara
    • Numpyro
    • TFP
  • TUTORIAL
    • Building a HMC sampler (internal modularity)
    • Stop/Restart the inference
  • A catalogue of inference methods, their API, the notebooks where they are showcased
  • Add developer documentation #235
  • EXPLAIN
    • Kernel pattern & composition
    • Modularity
    • 3 layers of abstraction
    • Sample then update parameters
    • Vectorizing
  • Add Colab notebook with examples running on GPU #25
@rlouf rlouf added this to the 1.0 milestone Jun 29, 2022
@rlouf rlouf added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 29, 2022
@rlouf
Copy link
Member Author

rlouf commented Jan 18, 2023

Better API documentation: https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/

@rlouf rlouf removed this from the 1.0 milestone May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rlouf