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

Add integrator/likelihoods doc #296

Merged
merged 10 commits into from
Jun 13, 2023
Merged

Add integrator/likelihoods doc #296

merged 10 commits into from
Jun 13, 2023

Conversation

thomaspinder
Copy link
Collaborator

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

Checklist

  • I've formatted the new code by running poetry run pre-commit run --all-files --show-diff-on-failure before committing.
  • [-] I've added tests for new code.
  • [-] I've added docstrings for the new code.

Description

This PR introduces a piece of documentation that provides users with a guide to likelihood functions and how the integration strategy attached to a likelihood function can be changed.

Issue Number: #295 #294

@thomaspinder thomaspinder added the documentation Improvements or additions to documentation label Jun 8, 2023
@thomaspinder thomaspinder added this to the v1.0.0 milestone Jun 8, 2023
@thomaspinder thomaspinder self-assigned this Jun 8, 2023
@thomaspinder thomaspinder marked this pull request as ready for review June 8, 2023 17:40
Copy link
Member

@daniel-dodd daniel-dodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To merge:

Looks good @thomaspinder. Left some comments.

For future:

Its nice that you break down the AbstractLikelihood down. As a further suggestion, it would be nice if we explicitly demonstrated what a user would have to code themselves if they wanted to add their own likelihood (like we do in the kernels guide), as an example. E.g., via a Poisson or Bernoulli (or Both). You could even maybe have a table that breaks things down with the maths and the code for the link functions, what the data looks like under each scenario -> e.g., count use Poisson, for Binary use Bernoulli, etc.

And it would be good to explicitly have links/ advertise custom likelihood, kernel, mean function etc, somewhere in our docs.

thomaspinder and others added 6 commits June 13, 2023 17:32
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
Co-authored-by: Daniel Dodd <daniel_dodd@icloud.com>
Signed-off-by: Thomas Pinder <tompinder@live.co.uk>
@thomaspinder
Copy link
Collaborator Author

Thanks @daniel-dodd - all suggestions actioned.

@thomaspinder thomaspinder merged commit edf965c into main Jun 13, 2023
13 checks passed
@thomaspinder thomaspinder deleted the guide_to_likelihoods branch June 13, 2023 18:53
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

Successfully merging this pull request may close these issues.

None yet

2 participants