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 pending evaluation also being listed as completed #5194

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented Nov 26, 2024

What changes are proposed in this pull request?

fix pending evaluation also being listed as completed

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

Using the model evaluation panel.

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.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

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 the evaluation panel to only display evaluations with valid results.
    • Introduced a method to verify the existence of evaluation results, improving error handling.

These changes refine the user experience by ensuring that the evaluation panel presents only relevant data, thereby increasing clarity and usability.

@imanjra imanjra requested a review from a team November 26, 2024 19:35
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes in this pull request modify the on_load method of the EvaluationPanel class to include a conditional check that filters evaluations based on the presence of results. A new method, has_evaluation_results, is introduced to verify if the specified evaluation key has associated results, enhancing error handling. These modifications refine the evaluation loading process and ensure that only valid evaluations are displayed in the evaluation panel.

Changes

File Change Summary
fiftyone/operators/builtins/panels/model_evaluation/init.py - Modified on_load method to filter evaluations with results.
- Added has_evaluation_results method for checking evaluation results.

Possibly related PRs

Suggested reviewers

  • brimoor
  • manivoxel51

🐇 "In the panel where results gleam,
We filter out the empty dream.
With checks in place, we now can see,
Only valid scores, as they should be.
Hop along, let data flow,
In the evaluation's gentle glow!" 🌟


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

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

🧹 Outside diff range and nitpick comments (1)
fiftyone/operators/builtins/panels/model_evaluation/__init__.py (1)

Line range hint 359-363: Consider using more specific exception handling

While the current implementation works correctly, it could be improved by catching specific exceptions rather than using a broad except clause.

Consider this improvement:

 def has_evaluation_results(self, dataset, eval_key):
     try:
         return bool(dataset._doc.evaluations[eval_key].results)
-    except Exception:
+    except (KeyError, AttributeError):
         return False

This makes it clearer which error conditions we expect and handle.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d88e777 and 8534ea5.

📒 Files selected for processing (1)
  • fiftyone/operators/builtins/panels/model_evaluation/__init__.py (1 hunks)
🔇 Additional comments (1)
fiftyone/operators/builtins/panels/model_evaluation/__init__.py (1)

83-88: LGTM: Proper filtering of evaluations with results

The conditional check effectively prevents pending evaluations from being incorrectly listed as completed by only including evaluations that have associated results.

@imanjra imanjra merged commit 0c51930 into release/v1.1.0 Nov 26, 2024
13 checks passed
@imanjra imanjra deleted the bugfix/pending-eval branch November 26, 2024 20:30
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