[Proposal] Evaluating regression with metric operators

[manushreegangwar]

What changes are proposed in this pull request?

This PR proposes how to use metric operators for computing per-sample and aggregate metrics (not to be merged).

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

# eval_metrics = [(metric_operator, metric_kwargs)] 

eval_results = dataset.evaluate_regressions(
    "predictions",
    gt_field="ground_truth",
    eval_key="eval",
    eval_metrics=eval_metrics,
)

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

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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.

[manushreegangwar]

Tested with AbsoluteError and Mean operators: https://github.com/manushreegangwar/custom_metrics/blob/main/eval_metrics/__init__.py

[manushreegangwar]

Sample showing absolute error 'eval' and absolute error 'eval_absolute_error' computed using metric operator:

<Sample: {
    'id': '674e42f0567b7e1228157c7a',
    'media_type': 'image',
    'filepath': '/home/manushree/fiftyone/quickstart/data/000880.jpg',
    'tags': ['validation'],
    'metadata': None,
    'created_at': datetime.datetime(2024, 12, 9, 16, 33, 19, 703000),
    'last_modified_at': datetime.datetime(2024, 12, 9, 16, 33, 20, 27000),
    'ground_truth': <Regression: {
        'id': '67571bcfaf69d19398e8e084',
        'tags': [],
        'value': 0.11694350486842164,
        'confidence': None,
    }>,
    'predictions': <Regression: {
        'id': '67571bcfaf69d19398e8e085',
        'tags': [],
        'value': 0.6432772871473967,
        'confidence': 0.8470792054938999,
    }>,
    'weather': 'rainy',
    'eval': 0.5263337822789751,
    'eval_absolute_error': 0.5263337822789751,
}>

mean absolute error       5.07
mean eval absolute error  5.07

[kaixi-wang]

I dont have full context, but if you’re thinking of this being a custom plugin, calling it outside the plugin framework here will likely cause circular dependencies