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 compute visualization results from operators #4324

Merged
merged 4 commits into from
May 9, 2024

Conversation

benjaminpkane
Copy link
Contributor

@benjaminpkane benjaminpkane commented Apr 30, 2024

What changes are proposed in this pull request?

Running compute_visualization (and potentially other methods) can sometimes lead to unserializable dtypes in numpy results. Adding a custom JSONEncoder on the server that handles these dtypes fixes the issue

How is this patch tested? If it is not, please explain why.

Unit test

Release Notes

  • Fixed serialization of NumPy scalars for the App

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features
    • Improved data handling by introducing a custom JSON encoder for NumPy types.

@benjaminpkane benjaminpkane added bug Bug fixes server Issues related to server features or changes labels Apr 30, 2024
@benjaminpkane benjaminpkane self-assigned this Apr 30, 2024
Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Walkthrough

The recent update brings a new Encoder class in decorators.py for customizing JSON encoding of NumPy types. This enhancement ensures accurate serialization of NumPy objects in JSON structures. The wrapper and create_response functions now utilize this custom Encoder class for JSON encoding, enhancing the handling of numeric data.

Changes

File Path Change Summary
fiftyone/server/decorators.py Added an Encoder class for NumPy JSON encoding; modified wrapper and create_response functions to use the custom Encoder for JSON encoding.

Poem

🐇✨
In the code's burrow, deep and wide,
A clever rabbit did decide,
To weave a web of JSON thread,
Where numbers dance and arrays tread.
Now every matrix, row, and byte,
In JSON's glow, shines ever bright. 🌟
🐇✨


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.

@ritch
Copy link
Contributor

ritch commented May 8, 2024

I noticed this as well...my fix was a lot less elegant!

@benjaminpkane benjaminpkane marked this pull request as ready for review May 8, 2024 15:14
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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between bdfc97f and 88ed97d.
Files selected for processing (1)
  • fiftyone/server/decorators.py (3 hunks)

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: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 88ed97d and 371d403.
Files selected for processing (2)
  • fiftyone/server/decorators.py (3 hunks)
  • tests/unittests/server_decorators_tests.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • fiftyone/server/decorators.py
Additional comments not posted (1)
tests/unittests/server_decorators_tests.py (1)

16-32: Ensure the test covers serialization of NumPy data types using the new Encoder class.

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: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 371d403 and 99ca0b0.
Files selected for processing (1)
  • fiftyone/server/decorators.py (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • fiftyone/server/decorators.py

@sashankaryal sashankaryal requested a review from a team May 9, 2024 15:20
@sashankaryal sashankaryal changed the base branch from develop to release/v0.24.0 May 9, 2024 15:21
Copy link
Contributor

@sashankaryal sashankaryal left a comment

Choose a reason for hiding this comment

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

🎨 👨‍🎨 🎸

@benjaminpkane benjaminpkane merged commit 59139cf into release/v0.24.0 May 9, 2024
9 of 10 checks passed
@benjaminpkane benjaminpkane deleted the bugfix/cast-np-encoder branch May 9, 2024 15:30
benjaminpkane added a commit that referenced this pull request May 20, 2024
* add np casting to json encoder

* isinstance

* add test

* add await
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug fixes server Issues related to server features or changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants