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

Issue 88 and 86: Update naming to be more consistent and add new overarching AbstractModel #89

Merged
merged 9 commits into from
Feb 29, 2024

Conversation

seabbs
Copy link
Collaborator

@seabbs seabbs commented Feb 28, 2024

As the title this PR closes #88 and #86.

It:

  • Uses model rather than process consistently
  • Renames generate_latent_process -> generate_latent to match the pattern of the other modules.
  • Renames RandomWalkLatentProcess -> RandomWalk again to match the pattern from the other module.
  • Renames make_epi_inference_model -> make_epi_aware again for naming consistency and as discussed (this change lacks a connected issue but I think is in scope of this PR.
  • Renames epimodel to epi_model again for consistency.
  • Moves all abstract types into a single file and adds a heirarchy type called AbstractModel
  • Generalises scan to expect a callable of type AbstractModel

Note as this change touches a lot of files it may cause issues for #85 - sorry!

Copy link
Collaborator

@SamuelBrand1 SamuelBrand1 left a comment

Choose a reason for hiding this comment

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

This looks good.

Using DocStringExtensions lowers the pain of renaming, because done correctly it should just work

@SamuelBrand1 SamuelBrand1 merged commit dbaad6b into main Feb 29, 2024
5 checks passed
@SamuelBrand1 SamuelBrand1 deleted the issue88-86 branch February 29, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Abstract**Process to Abstract**Model for consistency?
2 participants