talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
427 stars 97 forks source link

(3b -> 3a) Add method to get single instance permutations #1586

Closed roomrys closed 8 months ago

roomrys commented 11 months ago

Description

This PR adds a method to get single instance permutations across views (as hypotheses for the selected instance).

Design Decision: Missing Instances ~(To Be Implemented)~

~How do we handle the case when the selected instance is not in all views? We would want to create permutations that allow for empty instances in those views. We could essentially create sub-permutations by removing 1 view, then 2 views, and so on until there is only 2 views in the hypothesized frame. We would still need some error threshold to determine whether there is only a single selected instance across views. This will definitely increase the cost and complicate things.~

Update: We opted to add dummy instances for hypothesis testing. Furthermore, higher up in the stacked PRs (#1618), we add an InstanceGroup class to hold all Instances which are the same Instance but across views. Even higher up in the stacked PRs (#1165), we add a FrameGroup class which holds all LabeledFrames that are the same LabeledFrame across views. FrameGroup also manages all InstanceGroups for that temporal frame_idx, including hypothesis generation for "unlocked" Instances (i.e. Instances that are not in a locked InstanceGroup, not assigned/verified by the user).

Types of changes

Does this address any currently open issues?

[list open issues here]

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

coderabbitai[bot] commented 11 months ago

Walkthrough

The codebase has been updated to include several changes. The TriangulateSession class in the commands.py file now utilizes the itertools.permutations and itertools.product imports. Additionally, new static methods have been added to the TriangulateSession class for calculating reprojection errors and grouping instances and coordinates. The test suite in test_commands.py has been expanded to accommodate these changes and to update existing test functions for the TriangulateSession class.

Changes

File Path Summary
sleap/gui/commands.py - Added the itertools.permutations and itertools.product imports
- Modified the do_action method to use the new TriangulateSession method
- Adjusted the verify_views_and_instances method to use the new TriangulateSession method
- Added several new static methods in the TriangulateSession class for calculating reprojection errors and grouping instances and coordinates
tests/gui/test_commands.py - Updated test_triangulate_session and test_triangulate_session_get_permutations_of_instances test functions
- Added new test functions for TriangulateSession.get_products_of_instances, TriangulateSession.calculate_error_per_frame, and TriangulateSession._get_instance_grouping
- Updated test_triangulate_session_get_and_verify_enough_instances function to handle frame_idx instead of frame_inds and removed assertions related to the track parameter
- Updated test_triangulate_session_update_instances function to pass instances_and_coordinates[0] to the TriangulateSession.update_instances method

Poem

πŸ‡ A codebase evolves, as changes revolve, πŸ”„

New methods and tests, in the code's nests, πŸ§ͺ

It's a dance of progress, in the world of bytes, 🌐

As the rabbit hops, and the code delights. 🐰

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
roomrys commented 11 months ago

@coderabbitai review

codecov[bot] commented 10 months ago

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (9020afb) 73.76% compared to head (8267345) 73.81%.

Files Patch % Lines
sleap/gui/commands.py 86.36% 12 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## liezl/add-method-to-match-instances-across-views #1586 +/- ## ==================================================================================== + Coverage 73.76% 73.81% +0.05% ==================================================================================== Files 135 135 Lines 24557 24636 +79 ==================================================================================== + Hits 18115 18186 +71 - Misses 6442 6450 +8 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.