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

Interface Testing #44

Open
willtebbutt opened this issue Aug 1, 2024 · 0 comments
Open

Interface Testing #44

willtebbutt opened this issue Aug 1, 2024 · 0 comments
Assignees

Comments

@willtebbutt
Copy link
Member

willtebbutt commented Aug 1, 2024

Love the package. It looks like the interface has really been nicely reduced down to a couple of core bits.

It would be great if a module could be added inside this package with some testing functionality (maybe call it InterfaceTesting or something), containing two things:

  1. a function called test_interface (possibly in a submodule) which verifies whether or not a LatentDynamics, ObservationProcess, and StateSpaceModel that I've built from them correctly implement everything that you expect. The value of this is getting quick feedback from the package that tells me immediately whether I can expect my code to run.
  2. On the flip side, it would be great if you could publish a "test fake" model which implements the interface (but nothing more), and can be used when developing downstream algorithms that are intended to work with anything which implements the interface.

See e.g. https://invenia.github.io/blog/2020/11/06/interfacetesting/ for a good intro to this kind of thing, and does a good job of explaining why this kind of thing is generally helpful.

If this is something of interest, I'd be happy to help sketch out how it might look.

@willtebbutt willtebbutt changed the title test_interface function Interface Testing Aug 1, 2024
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

No branches or pull requests

1 participant