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 dataset group slice is not being used on launch_app #4423

Merged
merged 2 commits into from
May 24, 2024

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented May 24, 2024

What changes are proposed in this pull request?

Fixes an issue where dataset.group_slice is not being used in the app on launch_app

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

Using snippet below in py shell and ensuring app is opened with pcd slice selected

import fiftyone as fo
dataset = fo.load_dataset("quickstart-groups")
dataset.group_slice = "pcd"
session = fo.launch_app(dataset)

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

Fix launch_app not using dataset.group_slice

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
    • Enhanced session initialization to support group slicing when a dataset is present.

@imanjra imanjra requested a review from a team May 24, 2024 22:19
Copy link
Contributor

coderabbitai bot commented May 24, 2024

Walkthrough

The change involves enhancing the fiftyone/core/session/session.py file by introducing a new group_slice parameter in the __init__ function. This parameter is set to dataset.group_slice if a dataset is provided; otherwise, it defaults to None.

Changes

File Path Change Summary
fiftyone/core/session/session.py Added group_slice parameter to the __init__ function, defaulting to dataset.group_slice if available.

In the realm of code, where logic thrives,
A slice emerges, as datasets jive.
Sessions grouped, datasets fine,
With group_slice lead, all align.
🐰✨

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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

Outside diff range and nitpick comments (6)
fiftyone/core/session/session.py (6)

Line range hint 28-28: Replace bare except with except Exception to avoid catching exceptions like SystemExit or KeyboardInterrupt.

- except:
+ except Exception:

Line range hint 528-528: Replace bare except with except Exception to avoid catching exceptions like SystemExit or KeyboardInterrupt.

- except:
+ except Exception:

Line range hint 1150-1200: Refactor lambda expressions to def functions for better readability and debugging.

- on_close_session: t.Callable[[CloseSession], None] = lambda _: setattr(
-     session, "_wait_closed", True
- )
+ def on_close_session(_: CloseSession) -> None:
+     setattr(session, "_wait_closed", True)

Line range hint 1235-1235: Consider using importlib.util.find_spec to check for the availability of fiftyone.desktop instead of importing it directly.

- import fiftyone.desktop
+ import importlib.util
+ if importlib.util.find_spec("fiftyone.desktop") is not None:
+     import fiftyone.desktop

Line range hint 1300-1300: Replace bare except with except Exception to avoid catching exceptions like SystemExit or KeyboardInterrupt.

- except:
+ except Exception:

Line range hint 1310-1310: Replace bare except with except Exception to avoid catching exceptions like SystemExit or KeyboardInterrupt.

- except:
+ except Exception:
Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between ee0d85c and a247276.
Files selected for processing (1)
  • fiftyone/core/session/session.py (2 hunks)
Additional Context Used
Ruff (15)
fiftyone/core/session/session.py (15)

10-10: dataclasses.asdict imported but unused


28-28: Do not use bare except


528-528: Do not use bare except


1150-1152: Do not assign a lambda expression, use a def


1155-1157: Do not assign a lambda expression, use a def


1160-1162: Do not assign a lambda expression, use a def


1165-1167: Do not assign a lambda expression, use a def


1170-1172: Do not assign a lambda expression, use a def


1175-1177: Do not assign a lambda expression, use a def


1180-1182: Do not assign a lambda expression, use a def


1187-1193: Do not assign a lambda expression, use a def


1196-1200: Do not assign a lambda expression, use a def


1235-1235: fiftyone.desktop imported but unused; consider using importlib.util.find_spec to test for availability


1300-1300: Do not use bare except


1310-1310: Do not use bare except

Additional comments not posted (1)
fiftyone/core/session/session.py (1)

421-421: Ensure that group_slice is properly integrated and tested across the application.

Verification successful

The search results indicate that group_slice is extensively used and tested across various parts of the application, including unit tests and core functionalities. This suggests that group_slice is well-integrated and likely covered by tests.

  • Files with group_slice usage:
    • tests/unittests/view_tests.py
    • tests/unittests/utils3d_tests.py
    • tests/unittests/server_group_tests.py
    • tests/unittests/evaluation_tests.py
    • tests/unittests/dataset_tests.py
    • tests/unittests/group_tests.py
    • fiftyone/utils/utils3d.py
    • fiftyone/utils/cvat.py
    • fiftyone/utils/labelbox.py
    • fiftyone/utils/groups.py
    • fiftyone/utils/data/exporters.py
    • fiftyone/utils/annotations.py
    • fiftyone/server/aggregations.py
    • fiftyone/server/query.py
    • fiftyone/server/view.py
    • fiftyone/server/mutation.py
    • fiftyone/server/routes/frames.py
    • fiftyone/server/events/dispatch.py
    • fiftyone/migrations/revisions/v0_17_0.py
    • fiftyone/core/video.py
    • fiftyone/core/odm/mixins.py
    • fiftyone/core/stages.py
    • fiftyone/core/odm/dataset.py
    • fiftyone/core/view.py
    • fiftyone/core/state.py
    • fiftyone/core/session/session.py
    • fiftyone/core/session/client.py
    • fiftyone/core/media.py
    • fiftyone/core/metadata.py
    • fiftyone/core/dataset.py
    • fiftyone/core/expressions.py
    • fiftyone/core/aggregations.py
    • fiftyone/core/collections.py

Given the extensive usage and presence in unit tests, it appears that group_slice is properly integrated and tested across the application.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that `group_slice` is used consistently across the application.

# Test: Search for `group_slice` usage in Python files. Expect: Consistent usage across the application.
rg --type python $'group_slice'

Length of output: 61



Script:

#!/bin/bash
# Description: Verify that `group_slice` is used consistently across the application.

# Test: Search for `group_slice` usage in Python files. Expect: Consistent usage across the application.
rg --type py 'group_slice'

Length of output: 44873

fiftyone/core/session/session.py Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

Outside diff range and nitpick comments (3)
fiftyone/core/session/session.py (3)

Line range hint 27-27: Replace bare except with specific exceptions.

Using bare except statements can catch unexpected exceptions and obscure real errors. It's better to catch specific exceptions to avoid hiding bugs and to make the error handling clearer.

- except:
+ except ImportError:

Also applies to: 527-527, 1299-1299, 1309-1309


Line range hint 1149-1151: Replace lambda expressions with function definitions.

Using def for function definitions instead of assigning lambda expressions can improve readability and debugging. It's also more conventional in Python to use def for complex functions.

- on_close_session: t.Callable[[CloseSession], None] = lambda _: setattr(
-     session, "_wait_closed", True
- )
+ def on_close_session(_: CloseSession) -> None:
+     setattr(session, "_wait_closed", True)

Also applies to: 1154-1156, 1159-1161, 1164-1166, 1169-1171, 1174-1176, 1179-1181, 1186-1192, 1195-1199


Line range hint 1234-1234: Consider checking for module availability instead of importing directly.

Instead of importing fiftyone.desktop directly, which could fail if the module is not installed, use importlib.util.find_spec to check for its availability. This approach prevents runtime errors in environments where the module is not available.

- import fiftyone.desktop
+ import importlib.util
+ if importlib.util.find_spec("fiftyone.desktop") is not None:
+     import fiftyone.desktop
+ else:
+     raise ImportError("Module 'fiftyone.desktop' is not available")
Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between a247276 and f132021.
Files selected for processing (1)
  • fiftyone/core/session/session.py (2 hunks)
Additional Context Used
Ruff (14)
fiftyone/core/session/session.py (14)

27-27: Do not use bare except


527-527: Do not use bare except


1149-1151: Do not assign a lambda expression, use a def


1154-1156: Do not assign a lambda expression, use a def


1159-1161: Do not assign a lambda expression, use a def


1164-1166: Do not assign a lambda expression, use a def


1169-1171: Do not assign a lambda expression, use a def


1174-1176: Do not assign a lambda expression, use a def


1179-1181: Do not assign a lambda expression, use a def


1186-1192: Do not assign a lambda expression, use a def


1195-1199: Do not assign a lambda expression, use a def


1234-1234: fiftyone.desktop imported but unused; consider using importlib.util.find_spec to test for availability


1299-1299: Do not use bare except


1309-1309: Do not use bare except

Additional comments not posted (1)
fiftyone/core/session/session.py (1)

420-420: Ensure the new group_slice parameter is correctly integrated.

The addition of the group_slice parameter in the Session class constructor correctly implements the functionality described in the PR. This change should ensure that the group_slice from the dataset is used when the session is initialized, aligning with the PR's objectives.

Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

LGTM, tested and works!🥇

@brimoor brimoor merged commit a70ed4b into release/v0.24.0 May 24, 2024
10 checks passed
@brimoor brimoor deleted the bugfix/launch-app-grp-slice branch May 24, 2024 22:50
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