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

Fix duplicate skeletons during labels merge #2075

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

gitttt-1234
Copy link
Contributor

@gitttt-1234 gitttt-1234 commented Dec 20, 2024

Description

This PR fixes the duplicate skeleton issue when merging labels file. After every update to the labels file, we check if there's a existing skeleton that matches with a new Skeleton associated with an instance in the Labeled frame. If the skeleton doesn't match, then we add it to the list of skeletons in the Labels object.

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?

#2025, #1090, #713

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!

❤️

Summary by CodeRabbit

  • New Features

    • Enhanced management of skeletons, nodes, and tracks during initialization and merging processes.
    • Streamlined import and export functionalities in the application.
  • Bug Fixes

    • Adjusted expected output for track counts in import tests, reflecting updated processing logic.
  • Tests

    • Added a new test for adding instances to labeled frames.
    • Removed an outdated test related to skeleton unification.
  • Chores

    • General code cleanup for improved clarity and maintainability.

Copy link

coderabbitai bot commented Dec 20, 2024

Walkthrough

This pull request introduces modifications to the SLEAP (Social Leap) application's data handling, focusing on improvements in the Labels class within the dataset management system. The changes primarily affect how skeletons, nodes, and tracks are updated and merged during initialization. The modifications streamline the logic for managing these components, ensuring more precise handling of data structures, particularly when importing labels and working with instances across different frames and videos.

Changes

File Change Summary
sleap/io/dataset.py - Refined skeleton update logic to only update when list is empty
- Improved merging process for skeletons, nodes, and tracks
- Added more precise handling of duplicate tracks and instances
tests/gui/test_commands.py - Updated track count expectation in DeepLabCut import test
- Modified file dialog handling in export functionality
tests/io/test_dataset.py - Removed test_dont_unify_skeletons test
- Added new test_add_instance to verify instance addition logic

Sequence Diagram

sequenceDiagram
    participant Labels
    participant Skeletons
    participant Nodes
    participant Tracks

    Labels->>Skeletons: Check if empty
    alt Skeletons list is empty
        Labels->>Skeletons: Update skeletons
    end

    Labels->>Nodes: Check if empty
    alt Nodes list is empty
        Labels->>Nodes: Construct from skeletons
    end

    Labels->>Tracks: Check if empty
    alt Tracks list is empty
        Labels->>Tracks: Update tracks
    end

    Labels->>Labels: Merge matching components
Loading

Possibly related PRs

Suggested Labels

MultiView Stack

Poem

🐰 Hop, hop, through dataset's maze,
Skeletons dance in algorithmic ways,
Tracks merge, nodes align with grace,
A rabbit's code with elegant embrace,
SLEAP leaps forward, data's new phase! 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@gitttt-1234 gitttt-1234 requested a review from roomrys December 23, 2024 16:22
@gitttt-1234 gitttt-1234 marked this pull request as ready for review December 23, 2024 16:22
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
sleap/io/dataset.py (1)

486-503: Nested loops may add skeletons repeatedly or hamper performance.

This triple-nested loop can re-check skeleton matches an excessive number of times. Once a match has been found, consider breaking early to avoid redundant checks. Additionally, partial matches across multiple frames might make merges fail or run slower than necessary.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7785f66 and d0af4e2.

📒 Files selected for processing (3)
  • sleap/io/dataset.py (4 hunks)
  • tests/gui/test_commands.py (1 hunks)
  • tests/io/test_dataset.py (0 hunks)
💤 Files with no reviewable changes (1)
  • tests/io/test_dataset.py
🔇 Additional comments (1)
tests/gui/test_commands.py (1)

73-73: Change in the number of expected tracks from 3 to 2.

This updated assertion likely reflects the new logic that merges or removes duplicates. Confirm that the new expectation accurately represents the final track count after the improved merging routine.

sleap/io/dataset.py Show resolved Hide resolved
sleap/io/dataset.py Show resolved Hide resolved
Copy link

codecov bot commented Dec 23, 2024

Codecov Report

Attention: Patch coverage is 68.42105% with 6 lines in your changes missing coverage. Please review.

Project coverage is 75.59%. Comparing base (7991f14) to head (d0af4e2).
Report is 96 commits behind head on develop.

Files with missing lines Patch % Lines
sleap/io/dataset.py 68.42% 6 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2075      +/-   ##
===========================================
+ Coverage    75.43%   75.59%   +0.15%     
===========================================
  Files          134      134              
  Lines        24749    24437     -312     
===========================================
- Hits         18670    18473     -197     
+ Misses        6079     5964     -115     

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

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.

1 participant