[Temp MV fix to] add frame to Instance (when using Labels.add_instance)

[roomrys]

Description

A multiview branch beta tester has reported that they are unable to add an Instance to an InstanceGroup. This occurred when copying and pasting the Instance from a previous LabeledFrame. Upon investigation, we found the following error message

Traceback (most recent call last):
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/app.py", line 1497, in <lambda>
    lambda x=instance_group: self.commands.setInstanceGroup(x),
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 608, in setInstanceGroup
    self.execute(SetSelectedInstanceGroup, instance_group=instance_group)
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 245, in execute
    command().execute(context=self, params=kwargs)
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 141, in execute
    self.do_with_signal(context, params)
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 165, in do_with_signal
    cls.do_action(context, params)
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 2905, in do_action
    frame_group.add_instance(
  File "/Users/liezlmaree/Projects/sleap/sleap/io/cameras.py", line 1921, in add_instance
    self._raise_if_instance_incompatibile(instance=instance, camera=camera)
  File "/Users/liezlmaree/Projects/sleap/sleap/io/cameras.py", line 2366, in _raise_if_instance_incompatibile
    raise ValueError(
ValueError: Instance Instance(video=None, frame_idx=None, points=[Nose: (366.9, 588.4), Ear_R: (425.4, 574.4), Ear_L: (413.2, 618.5), TTI: (467.2, 652.7), TailTip: (376.4, 597.2), Head: (411.0, 596.2), Trunk: (465.0, 616.4), Tail_0: (429.1, 668.7), Tail_1: (391.2, 658.5), Tail_2: (367.4, 628.4), Shoulder_left: (413.2, 608.5), Shoulder_right: (453.0, 558.3), Haunch_left: (433.1, 630.4), Haunch_right: (499.4, 608.7), Neck: (427.0, 598.5)], track=Track(spawned_on=0, name='track_0')) is not linked to a LabeledFrame. Cannot add to FrameGroup.

(thank you previous dev/self for adding checks and error messages - otherwise this may have turned into quite the chase).

⚠️ Note to future dev! There is already a fix for this in the develop branch that implements a new InstancesList class that replaces the native list implementation for Labels._instanceand ensures that the LabeledFrame is updated when an Instance is moved around, deleted, etc. Thus, this fix is temporary and should not be merged into develop. See #1807 for more details.

Types of changes

• Bugfix
• New feature
• Refactor / Code style update (no logical changes)
• Build / CI changes
• Documentation Update
• Other (explain)

Does this address any currently open issues?

• Add InstancesList class to handle backref to LabeledFrame #1807

Outside contributors checklist

• Review the guidelines for contributing to this repository
• Read and sign the CLA and add yourself to the authors list
• Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
• Add tests that prove your fix is effective or that your feature works
• Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

❤️

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.18%. Comparing base (c7185c7) to head (5098230).
Report is 1 commits behind head on liezl/add-gui-elements-for-sessions.

Additional details and impacted files

@@                         Coverage Diff                          @@
##           liezl/add-gui-elements-for-sessions    #2011   +/-   ##
====================================================================
  Coverage                                74.18%   74.18%           
====================================================================
  Files                                      135      135           
  Lines                                    25440    25441    +1     
====================================================================
+ Hits                                     18873    18874    +1     
  Misses                                    6567     6567           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.