ReactiveBayes / RxInfer.jl

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

Documentation need adjustments for new GraphPPL.jl #257

Closed bvdmitri closed 2 months ago

bvdmitri commented 3 months ago

It is a tracking progress issue. I've started adjusting the documentation in a separate branch #dev-4.0.0-documentatation.

Contributing section

Library section

Manuals

Inference

We also need a new section on migration from previous RxInfer to the new one.

I may need your help @albertpod , @bartvanerp , @wouterwln with it. More structured request will be a bit later. If not changing, but at least reviewing. Let's make it a nicer release.

bvdmitri commented 2 months ago

@wouterwln I've updated the constraints specification documentation to my taste in this branch. Could you please check it out and merge it with https://github.com/ReactiveBayes/RxInfer.jl/pull/172 ?

Would be also great if you could review the @meta section

wouterwln commented 2 months ago

Reviewing in #documentation-check.

wouterwln commented 2 months ago

@bvdmitri I did a revision of the contribution guide that's not reflected in this branch, is this on purpose or did we branch before I did the revision in main?

bvdmitri commented 2 months ago

Yeah, we branch out before you did the revision, I will update the status of this branch and sync it with the main today such that we can work on the most recent version. Thanks for reminding me.

bvdmitri commented 2 months ago

@wouterwln I synced this branch with the main