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

matched_instance_distances in sleap.info.metrics does not have default matching function #1517

Open
eringiglio opened this issue Sep 26, 2023 · 1 comment
Labels
documentation This issue exists because the documentation is outdated. enhancement New feature or request fixed in future release Fix or feature is merged into develop and will be available in future release.

Comments

@eringiglio
Copy link

What it says on the tin: I'd like to use sleap.info.metrics.matched_instance_distances in a routine I'm writing to identify low quality user-modified instances. I was delighted to find it in the documentation because I was expecting to need to write my own routine. Unfortunately, it appears to require match_lists_function to be passed to it, and I can't find this function referenced anywhere else in the repository. There's no default matching function listed. Does such a thing exist?

I want to compare predicted and user-generated instances for a specific model so that I can flag user-generated canonical instances that the model does a particularly bad job of predicting, just in case they're rough. In #1516 I have more context on that, but this would be an awesome function for building that except... that there's no clear options for this match_lists_function anywhere I can find on the github.

@roomrys
Copy link
Collaborator

roomrys commented Sep 28, 2023

I'd just like to point out as a word of warning that although the matched_instance_distances function is shipped with SLEAP, it is not used anywhere in the core package... meaning that it is undertested. #1520 adds a small test and additional development using this function (in regards to #1516) would also ensure/test it's reliability.

@roomrys roomrys added fixed in future release Fix or feature is merged into develop and will be available in future release. enhancement New feature or request documentation This issue exists because the documentation is outdated. labels Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue exists because the documentation is outdated. enhancement New feature or request fixed in future release Fix or feature is merged into develop and will be available in future release.
Projects
None yet
Development

No branches or pull requests

2 participants