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

Add SuggestionFrame #89

Merged
merged 2 commits into from
May 1, 2024
Merged

Add SuggestionFrame #89

merged 2 commits into from
May 1, 2024

Conversation

talmo
Copy link
Contributor

@talmo talmo commented May 1, 2024

Summary by CodeRabbit

  • New Features

    • Introduced the ability to read and write suggestion metadata in SLEAP labels files, enhancing file handling capabilities.
    • Added a new attribute to the Labels class to support a list of suggestion frames associated with datasets.
  • Documentation

    • Updated documentation to reflect new functionalities and classes related to suggestion handling in video frames.

@talmo talmo linked an issue May 1, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented May 1, 2024

Warning

Rate Limit Exceeded

@talmo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 23 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 5a0607d and 1a6bc23.

Walkthrough

The update introduces the handling of SuggestionFrame objects in the SLEAP project, enhancing the software's ability to manage suggestions related to video frames. New functionalities include reading and writing these objects, and they are now integrated into the labels system, enriching the dataset's metadata capabilities.

Changes

File Path Change Summary
sleap_io/__init__.py Added import for SuggestionFrame.
sleap_io/io/slp.py Introduced functions to read and write SuggestionFrame, updated label handling.
sleap_io/model/labels.py Updated Labels class to include suggestions attribute.
sleap_io/model/suggestions.py Created to define SuggestionFrame.
tests/io/test_slp.py Added tests for new suggestion handling.

🐇✨
A leap in code, a hop in style,
New frames of thoughts, mile by mile.
Suggestions come, and now they stay,
In structured form, they find their way.
🌟📝🐾


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.
  • 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.

Copy link

codecov bot commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.68%. Comparing base (61ab2d3) to head (1a6bc23).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #89      +/-   ##
==========================================
+ Coverage   95.61%   95.68%   +0.06%     
==========================================
  Files          14       15       +1     
  Lines        1665     1691      +26     
==========================================
+ Hits         1592     1618      +26     
  Misses         73       73              

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

@talmo
Copy link
Contributor Author

talmo commented May 1, 2024

@coderabbitai review

Copy link
Contributor

@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

Out of diff range and nitpick comments (8)
sleap_io/__init__.py (4)

Line range hint 3-3: Consider removing or using the unused import __version__.

- from sleap_io.version import __version__

Line range hint 4-4: Consider removing or using the unused imports Node, Edge, Skeleton, Symmetry.

- from sleap_io.model.skeleton import Node, Edge, Skeleton, Symmetry

Line range hint 5-5: Consider removing or using the unused import Video.

- from sleap_io.model.video import Video

Line range hint 7-11: Consider removing or using the unused imports Point, PredictedPoint, Track, Instance, PredictedInstance.

- from sleap_io.model.instance import (
-     Point,
-     PredictedPoint,
-     Track,
-     Instance,
-     PredictedInstance,
- )
tests/io/test_slp.py (2)

Line range hint 4-4: Consider removing or using the unused import Video.

- from sleap_io import Video

Line range hint 52-52: Replace type comparison with isinstance() for better practice and flexibility.

- assert type(labels) == Labels
+ assert isinstance(labels, Labels)
sleap_io/model/labels.py (1)

Line range hint 73-73: Replace type comparison with isinstance() for better practice and flexibility.

- if type(key) == int:
+ if isinstance(key, int):
sleap_io/io/slp.py (1)

Line range hint 27-29: Consider removing or using the unused imports write_hdf5_dataset, write_hdf5_group, write_hdf5_attrs.

- from sleap_io.io.utils import (
-     write_hdf5_dataset,
-     write_hdf5_group,
-     write_hdf5_attrs,
- )

sleap_io/model/suggestions.py Outdated Show resolved Hide resolved
from sleap_io import LabeledFrame, Instance, PredictedInstance, Video, Track
from sleap_io import (
LabeledFrame,
Instance,
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider removing or using the unused import Instance.

- from sleap_io import Instance

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Instance,

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@talmo talmo merged commit 5323396 into main May 1, 2024
8 checks passed
@talmo talmo deleted the talmo/add-suggestions branch May 1, 2024 06:12
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.

Support suggestions
1 participant