ReactiveBayes / ReactiveBayes/ReactiveMP.jl
[Feature]: `SoftDot` node documentation and test
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 118
- Forks
- 19
- Avg merge
- 7d 47m
- Merged PRs (30d)
- 1
Description
Parent Epic
#554
Feature Summary
Provide derivations for the rules in the SoftDot node and improve the quality of the test suite.
Feature Description
The SoftDot node has an undocumented functional form, the rules are not straightforward and not documented either in the Overleaf file or in the repository. Furthermore, the tests are extremely barebones and do not test actual functionality, providing
Feature Goals
- Document rule derivations
- Improve test suite for all rules
- Improve performance of rules
Tasks
- Add
SoftDotrules for x to overleaf - Add
SoftDotrules for y to overleaf - Add
SoftDotrules for gamma to overleaf - Add
SoftDotrules for theta to overleaf - Add tests for x
- Add tests for y
- Add tests for gamma
- Add tests for theta
Dependencies
No response
Estimated Timeline
No response
Related Issues / PRs
No response
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the SoftDot node implementation and its existing tests, then review the functional form and current rule coverage. Use the Overleaf material and repository tests as the work areas; done means derivations for x, y, gamma, and theta are documented, each has functional tests, and rule performance is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100