aesara-devs / aeppl

Tools for an Aesara-based PPL.
https://aeppl.readthedocs.io
MIT License
64 stars 20 forks source link

Add rudimentary documentation for AePPL #213

Closed rlouf closed 1 year ago

rlouf commented 1 year ago

In this PR I try to add enough documentation to allow anyone to get started with AePPL.

codecov[bot] commented 1 year ago

Codecov Report

Base: 95.15% // Head: 95.15% // No change to project coverage :thumbsup:

Coverage data is based on head (5201c86) compared to base (b27f95d). Patch has no changes to coverable lines.

:exclamation: Current head 5201c86 differs from pull request most recent head 5059228. Consider uploading reports for the commit 5059228 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #213 +/- ## ======================================= Coverage 95.15% 95.15% ======================================= Files 12 12 Lines 2023 2023 Branches 253 253 ======================================= Hits 1925 1925 Misses 56 56 Partials 42 42 ``` | [Impacted Files](https://codecov.io/gh/aesara-devs/aeppl/pull/213?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs) | Coverage Δ | | |---|---|---| | [aeppl/censoring.py](https://codecov.io/gh/aesara-devs/aeppl/pull/213/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs#diff-YWVwcGwvY2Vuc29yaW5nLnB5) | `96.22% <ø> (ø)` | | | [aeppl/dists.py](https://codecov.io/gh/aesara-devs/aeppl/pull/213/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs#diff-YWVwcGwvZGlzdHMucHk=) | `94.50% <ø> (ø)` | | | [aeppl/joint\_logprob.py](https://codecov.io/gh/aesara-devs/aeppl/pull/213/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs#diff-YWVwcGwvam9pbnRfbG9ncHJvYi5weQ==) | `95.00% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aesara-devs)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

rlouf commented 1 year ago

This is ready for review. I added basic documentation: a list of supported random variables, transforms, scan, mixtures, a home page and a few examples.