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

support loading slp files with non-compound types and str in metadata #1566

Merged
merged 2 commits into from
Jan 5, 2024

Conversation

lambdaloop
Copy link
Contributor

@lambdaloop lambdaloop commented Oct 23, 2023

Description

This makes the loading of slp files more robust. Specifically, it allows storing points, pred_points, frames, and instances as non-compound types in the h5 file, by casting them as needed.

It is backwards compatible with the previous code, so that the default slp files load fine.

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?

[list open issues here]

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

  • Bug Fix: Improved the handling of data types in our software. This includes better management of complex data types and ensuring that all data is in the correct format for processing. This will enhance the reliability of our software and reduce the likelihood of errors.
  • New Feature: Added a function to automatically convert certain data arrays into complex data types if they are not already. This will improve the software's performance and ensure consistency in data processing.

@coderabbitai
Copy link

coderabbitai bot commented Oct 23, 2023

Walkthrough

The changes primarily focus on enhancing data handling in the HDF5 format. They introduce checks for data types, conversion of JSON attributes, and casting of arrays into complex data types. The modifications ensure robustness and consistency in data processing.

Changes

File Summary
.../format/hdf5.py Introduced checks for JSON attribute data types and conversion if necessary. Added cast_as_compound function to cast arrays into complex data types. Arrays points_dset, pred_points_dset, instances_dset, and frames_dset are now cast into complex dtypes. old_labels variable is assigned the result of decoding the JSON attribute.

🐇

"In the land of code, where the shadows lie,

A rabbit hopped, with a twinkle in its eye.

Casting arrays, checking types, oh so sly,

Ensuring data flows, under the binary sky. 🌌"

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's AI:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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.
    • @coderabbitai read the files in the src/scheduler package and generate 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.
  • 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 to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dbe14a8 and 4eb593a.
Files selected for processing (1)
  • sleap/io/format/hdf5.py (3 hunks)
Additional comments: 4
sleap/io/format/hdf5.py (4)
  • 84-87: The new code checks if the json attribute is a string before decoding it. This is a good practice as it prevents potential errors that could occur if the attribute is already a string. This change is backward compatible and should not affect the functionality of the code.

  • 157-163: The cast_as_compound function is a new addition that casts an array into a complex data type. This function is used later in the code to cast points, instances, and frames into complex data types if they are not already. This change enhances the robustness of the loading process by allowing these arrays to be stored as non-compound types in the h5 file.

  • 166-194: The new code uses the cast_as_compound function to cast points, instances, and frames into complex data types if they are not already. This change enhances the robustness of the loading process by allowing these arrays to be stored as non-compound types in the h5 file. However, it's important to ensure that the casting process does not alter the data in a way that could affect the functionality of the code.

  • 328-331: Similar to the change in lines 84-87, the new code checks if the json attribute is a string before decoding it. This is a good practice as it prevents potential errors that could occur if the attribute is already a string. This change is backward compatible and should not affect the functionality of the code.

@codecov
Copy link

codecov bot commented Oct 24, 2023

Codecov Report

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

Comparison is base (2d24296) 73.38% compared to head (4e5ce45) 73.36%.
Report is 1 commits behind head on develop.

Files Patch % Lines
sleap/io/format/hdf5.py 61.53% 10 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1566      +/-   ##
===========================================
- Coverage    73.38%   73.36%   -0.02%     
===========================================
  Files          134      134              
  Lines        24024    24048      +24     
===========================================
+ Hits         17629    17643      +14     
- Misses        6395     6405      +10     

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

@lambdaloop
Copy link
Contributor Author

@roomrys @talmo Any chance you could merge this? This would allow people to export slp datasets from a web annotation system (such as https://lambdaloop.com/anivia/ ) and then load them into SLEAP.

@roomrys roomrys self-requested a review January 5, 2024 20:46
@roomrys roomrys merged commit 14b5b78 into talmolab:develop Jan 5, 2024
8 of 9 checks passed
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.

2 participants