ReactiveBayes / RxInfer.jl

Julia package for automated Bayesian inference on a factor graph with reactive message passing
MIT License
254 stars 24 forks source link

Initial implementation of custom node tutorial #105

Closed wouterwln closed 1 year ago

wouterwln commented 1 year ago

Here's my initial effort to create a tutorial for making a custom node. There's a couple of things I had questions about and that I left intentionally vague, so this is by no means my final effort towards this. My questions are the following:

I'll expand the latter part of the explanation (from the marginal computation onwards) a bit further later, but as of writing this it's 6pm on a Friday so my brain is fried. Have a nice weekend.

review-notebook-app[bot] commented 1 year ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

codecov-commenter commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (20a1499) 79.91% compared to head (504e853) 79.91%.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #105 +/- ## ======================================= Coverage 79.91% 79.91% ======================================= Files 10 10 Lines 1200 1200 ======================================= Hits 959 959 Misses 241 241 ```

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

bvdmitri commented 1 year ago

This is a great addition, I like the story and the explanation is clear in my opinion. I would, however, argue that this should be added to the documentation instead as a page (not as an example) and ReactiveMP should have a documentation page with the API documentation. Would it be too difficult to convert the example to a documentation page? The documentation does allow code execution too. See the @example macro from the Documenter.

bvdmitri commented 1 year ago

I've addressed my own comments. The rest is fine by me. Thanks @wouterwln and @bartvanerp !