Improve API documentation of Nodes

liesel-devs / liesel

A probabilistic programming framework

https://liesel-project.org

MIT License

38 stars 2 forks source link

Improve API documentation of Nodes #116

Closed jobrachem closed 10 months ago

jobrachem commented 10 months ago

See #112

[x] Obs
[x] Param
[x] add_group
[x] Calc
[x] Data
[x] Dist
[x] Group
[ ] InputGroup
[x] Node
[ ] NodeState
[ ] TransientCalc
[ ] TransientDist
[ ] TransientIdentity
[ ] TransientNode
[x] Var

jobrachem commented 10 months ago

Hey @hriebl or @wiep, I don't know how to describe what the parameter _needs_seed of a lsl.Node is for. Could one of you give me 1-2 sentences describes its purpose and usage? Thanks!