Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bring "Why it works" closer to the modelled generative process #112

Open
SamuelBrand1 opened this issue Sep 30, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@SamuelBrand1
Copy link
Collaborator

We discussed this in #91 but I'm starting to lean more towards rewriting the "Why it works" description so that it precisely does the maths underlying the generative model described in "Getting started".

The reason why "Why it works" approaches the problem from the perspective it takes is essentially subjective, and it would probably be better to bring the maths towards the code.

Of course, noting that that the approaches are all mathematically equivalent but I think this would make it clearer for users.

@SamuelBrand1 SamuelBrand1 added the documentation Improvements or additions to documentation label Sep 30, 2024
@seabbs
Copy link
Contributor

seabbs commented Sep 30, 2024

We now have the analytical solutions written from the perspective of the why it works so if doing that we would need to update those as well

My preference is to keep it coming from the direction it does but to more clearly link out to the expressions elsewhere in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants