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

Add a genkitx evaluator plugin - Promptfoo #14

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

yukinagae
Copy link
Contributor

@yukinagae yukinagae commented Sep 25, 2024

Describe The changes

This change is a:
[] Bug fix
[x] New awesome stuff
[] Documentation update
[] Other

Added a evaluator plugin, genkitx-promptfoo.
It utilizes Promptfoo assertions within Genkit to enhance the evaluation processes.

Like this pull request? Vote for it by adding a 👍

Summary by CodeRabbit

  • New Features

    • Introduced a new section for "Evaluator Plugins" in the documentation.
    • Added the genkitx-promptfoo plugin specifically for Promptfoo Evaluations.
  • Documentation

    • Renamed and reorganized the "Other Plugins" section for improved clarity.

Copy link

coderabbitai bot commented Sep 25, 2024

Walkthrough

The pull request introduces a structural update to the README.md file, specifically reorganizing the plugins section. The previously combined "Other Plugins" section is now divided into two separate sections: "Evaluator Plugins" and "Other Plugins." The new "Evaluator Plugins" section includes the addition of the genkitx-promptfoo plugin, which is designed for Promptfoo Evaluations. The existing content in the "Other Plugins" section remains unchanged but is now positioned after the new section.

Changes

File Change Summary
README.md - Added new section: "Evaluator Plugins"
- Included new plugin: genkitx-promptfoo for Promptfoo Evaluations
- Renamed section: "Other Plugins" (now follows "Evaluator Plugins")

Possibly related PRs

Suggested reviewers

  • xavidop

Poem

🐇 In the garden of code, we hop and play,
New sections bloom, brightening the way.
Evaluator Plugins join the fun,
With genkitx-promptfoo, our work's just begun!
Old friends still linger, side by side,
In the world of plugins, we take great pride! 🌼


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.

CodeRabbit Configuration 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

@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 (2)
README.md (2)

Line range hint 25-36: Update the table of contents to include the new "Evaluator Plugins" section.

The new "Evaluator Plugins" section added to the document is not reflected in the table of contents. To maintain consistency and improve navigation, please update the "Contents" section to include the new "Evaluator Plugins" entry.

Consider adding the following line to the "Contents" section:

 ## Contents <!-- omit from toc -->
 - [Plugins](#plugins)
   - [JavaScript - Official](#javascript---official)
   - [JavaScript - Community](#javascript---community)
+  - [Evaluator Plugins](#evaluator-plugins)
   - [Golang - Official](#golang---official)
   - [Golang - Community](#golang---community)
 - [Talks](#talks)

89-91: LGTM! Consider adding a brief description for the new plugin.

The addition of the "Evaluator Plugins" subsection and the genkitx-promptfoo plugin is well-organized and consistent with the PR objectives. Great job on improving the structure of the document!

To maintain consistency with other plugin entries, consider adding a brief description of the genkitx-promptfoo plugin. For example:

 3. Evaluator Plugins
-   - [`genkitx-promptfoo`](https://github.com/yukinagae/genkitx-promptfoo) - Plugin for Promptfoo Evaluations.
+   - [`genkitx-promptfoo`](https://github.com/yukinagae/genkitx-promptfoo) - Plugin for Promptfoo Evaluations. Integrates Promptfoo assertions into the Genkit framework for enhanced evaluation processes.
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b86e69a and b4a3bdf.

Files selected for processing (1)
  • README.md (1 hunks)
Additional comments not posted (1)
README.md (1)

Line range hint 1-368: Overall, the changes improve the document structure and content.

The addition of the "Evaluator Plugins" section and the genkitx-promptfoo plugin entry enhances the organization of the README.md file. The changes are consistent with the PR objectives and contribute positively to the curated list of Firebase Genkit resources.

Two minor suggestions were made to further improve the document:

  1. Update the table of contents to include the new "Evaluator Plugins" section.
  2. Add a brief description for the genkitx-promptfoo plugin to maintain consistency with other entries.

These small adjustments will ensure the document remains well-structured and informative for users exploring Firebase Genkit resources.

@xavidop xavidop merged commit aa2d9c2 into xavidop:main Sep 25, 2024
4 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