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

Consolidate examples in `RxInferExamples.jl` repository #319

Open albertpod opened 1 week ago

albertpod commented 1 week ago

A few months ago, @bartvanerp created the RxInferExamples.jl repository, which currently features only the drone example. To encourage more community contributions and keep our main repository cleaner, I propose moving all examples from the main RxInfer repository to RxInferExamples.jl. This change can help:

  1. Encourage more contributions from the community.
  2. Keep the main repository clean and focused on core functionality.
  3. Make it easier for users to find and add examples.

This could be a great first issue to tackle for other contributors @ReactiveBayes/bayesian-beyond.

wouterwln commented 1 week ago

I'd be cautious about moving examples from the RxInfer documentation page. I had a discussion with the AIF institute folks last week who find it difficult to get started in RxInfer, partly because it takes quite a few examples to get your head around probabilistic modeling using RxInfer. I think the current amount of examples on the documentation page is good, but we should indeed extend RxInferExamples

bvdmitri commented 1 week ago

Moving examples to their own repository is not a bad idea, but they should remain part of the documentation. It wouldn’t be difficult for RxInferExamples to have its own documentation infrastructure with a separate webpage. However, merging both documentations together could be more challenging. Either approach works for me. In the first case, we can simply include a link to redirect users to the separate webpage.