forked from openai/evals
-
Notifications
You must be signed in to change notification settings - Fork 6
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
enzyme benchmark #10
Merged
Merged
enzyme benchmark #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Linmj-Judy
pushed a commit
that referenced
this pull request
Feb 27, 2024
Update PULL_REQUEST_TEMPLATE.md
Linmj-Judy
pushed a commit
that referenced
this pull request
Feb 27, 2024
# Thank you for contributing an eval!♥️ 🚨 Please make sure your PR follows these guidelines, **failure to follow the guidelines below will result in the PR being closed automatically**. Note that even if the criteria are met, that does not guarantee the PR will be merged nor GPT-4 access be granted. 🚨 **PLEASE READ THIS**: In order for a PR to be merged, it must fail on GPT-4. We are aware that right now, users do not have access, so you will not be able to tell if the eval fails or not. Please run your eval with GPT-3.5-Turbo, but keep in mind as we run the eval, if GPT-4 gets higher than 90% on the eval, we will likely reject it since GPT-4 is already capable of completing the task. We plan to roll out a way for users submitting evals to see the eval performance on GPT-4 soon. Stay tuned! Until then, you will not be able to see the eval performance on GPT-4. **Starting April 10, the minimum eval count is 15 samples, we hope this makes it easier to create and contribute evals.** Also, please note that we're using **Git LFS** for storing the JSON files, so please make sure that you move the JSON file to Git LFS before submitting a PR. Details on how to use Git LFS are available [here](https://git-lfs.com). ## Eval details 📑 ### Eval name resource_id_extraction ### Eval description This Eval asks the model to identify UI elements and extract their resource ID from Android XML dumps. Android allows you to serialize the content of the screen to XML using accessibility information. A human can (with effort) read through this XML and understand approximately what is visible on the screen and what the semantic intent of UI elements are. Each sample in the eval contains: - Instructions to find and identify a ui element and extract its resource id (or return error code) - An XML dump from an actual Android app - A description of a UI element that may or may not be present in the xml The eval uses the simple "includes" test to see if the correct resource id is returned. ### What makes this a useful eval? This eval is useful because: - It requires semantic understanding of ui elements (foundational capacity) (eg that the ⭐ button means "add to favorites" and the ➕ button is used to create a new contact) - It tests against hallucinations (eg sometimes the model may hallucinate resource ids that don't exist) - It enforces error codes that distinguish between different problem states (system message steer-ability) Given certain successes, it seems that the model has the capacity to return good responses, but often fails to do so. This eval can be extended by: 1. Adding more test cases / xml dumps (especially more complex cases using the larger gpt4 context window) 2. Adding more obscure descriptions of ui elements 3. Extracting information other than resource ids, for example "center point" of ui elements (computable via their bounding box) ## Criteria for a good eval ✅ Below are some of the criteria we look for in a good eval. In general, we are seeking cases where the model does not do a good job despite being capable of generating a good response (note that there are some things large language models cannot do, so those would not make good evals). Your eval should be: - [x] Thematically consistent: The eval should be thematically consistent. We'd like to see a number of prompts all demonstrating some particular failure mode. For example, we can create an eval on cases where the model fails to reason about the physical world. - [x] Contains failures where a human can do the task, but either GPT-4 or GPT-3.5-Turbo could not. - [x] Includes good signal around what is the right behavior. This means either a correct answer for `Basic` evals or the `Fact` Model-graded eval, or an exhaustive rubric for evaluating answers for the `Criteria` Model-graded eval. - [x] **Include at least 15 high-quality examples.** If there is anything else that makes your eval worth including, please document it below. ### Unique eval value A lot of implicit information is conveyed in UIs. Models reading serialized UIs have the ability to understand some of that implicit information. This is quite valuable, not least because it is required in order to give good results for code completion and generation. This eval is uniquely valuable because it gives a structured way to definitively test the model's understanding of code/UIs from something like a "reading comprehension" perspective, rather than just generation. ## Eval structure 🏗️ Your eval should - [x] Check that your data is in `evals/registry/data/{name}` - [x] Check that your YAML is registered at `evals/registry/evals/{name}.yaml` - [x] Ensure you have the right to use the data you submit via this eval (For now, we will only be approving evals that use one of the existing eval classes. You may still write custom eval classes for your own cases, and we may consider merging them in the future.) ## Final checklist 👀 ### Submission agreement By contributing to Evals, you are agreeing to make your evaluation logic and data under the same MIT license as this repository. You must have adequate rights to upload any data used in an Eval. OpenAI reserves the right to use this data in future service improvements to our product. Contributions to OpenAI Evals will be subject to our usual Usage Policies (<https://platform.openai.com/docs/usage-policies>). - [x] I agree that my submission will be made available under an MIT license and complies with OpenAI's usage policies. ### Email address validation If your submission is accepted, we will be granting GPT-4 access to a limited number of contributors. Access will be given to the email address associated with the merged pull request. - [x] I acknowledge that GPT-4 access will only be granted, if applicable, to the email address used for my merged pull request. ### Limited availability acknowledgment We know that you might be excited to contribute to OpenAI's mission, help improve our models, and gain access to GPT-4. However, due to the requirements mentioned above and the high volume of submissions, we will not be able to accept all submissions and thus not grant everyone who opens a PR GPT-4 access. We know this is disappointing, but we hope to set the right expectation before you open this PR. - [x] I understand that opening a PR, even if it meets the requirements above, does not guarantee the PR will be merged nor GPT-4 access be granted. ### Submit eval - [x] I have filled out all required fields of this form - [x] I have used **Git LFS** for the Eval JSON data - [ ] (Ignore if not submitting code) I have run `pip install pre-commit; pre-commit install` and have verified that `black`, `isort`, and `autoflake` are running when I commit and push Failure to fill out all required fields will result in the PR being closed. ### Eval JSON data Since we are using Git LFS, we are asking eval submitters to add in as many Eval Samples (at least 5) from their contribution here: :warning: I was only able to add 1 due to length limits of the PR body. Sorry! <details> <summary>View evals in JSON</summary> ### Eval ```jsonl {"ideal": "com.google.android.apps.photos:id/selected_account_disc", "input": [{"role": "system", "content": "\nYou have two tasks:\n- Identify an interactable UI element in an Android XML dump based on a description of of what it looks like, where it is, or what it does.\n- Retrieve the corresponding resource ID you would use to interact with that UI element.\nYou'll be given two inputs:\n- An XML output from the 'dumpXMLHierarchy'.\n- A description of a UI element.\nBased on these inputs your output should be as follows:\n- If you find the described UI element and it has a resource ID, return the resource ID.\n- If you don't find the described UI element, return \"element_not_found\".\n- If the described UI element is there but it doesn't have a resource ID, return \"no_resource_id\".\n"}, {"role": "user", "content": "XML output: <hierarchy rotation=\"0\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.LinearLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/action_bar_root\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"android:id/content\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/touch_capture_view\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/photo_container\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\" /><node index=\"1\" text=\"\" resource-id=\"com.google.android.apps.photos:id/drawer_layout\" class=\"androidx.drawerlayout.widget.DrawerLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/main_container\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/toolbar_parent\" class=\"android.view.ViewGroup\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/touch_capture_view\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/empty_view_container\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.ScrollView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"true\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,312][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.LinearLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,965][1080,1621]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/empty_page_image\" class=\"android.widget.ImageView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[237,965][842,1180]\" /><node index=\"1\" text=\"Take a picture. Photos & videos appear here.\" resource-id=\"com.google.android.apps.photos:id/empty_page_caption\" class=\"android.widget.TextView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[155,1230][925,1406]\" /><node index=\"2\" text=\"No Photos\" resource-id=\"com.google.android.apps.photos:id/empty_page_title_top\" class=\"android.widget.TextView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[155,1406][925,1533]\" /><node index=\"3\" text=\"\" resource-id=\"\" class=\"android.widget.LinearLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[496,1533][584,1577]\" /></node></node></node><node index=\"1\" text=\"\" resource-id=\"com.google.android.apps.photos:id/fragment_container\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/photos_photogrid_date_scrubber_view\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/recycler_view\" class=\"android.support.v7.widget.RecyclerView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"true\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2138]\" /></node></node></node></node></node><node index=\"1\" text=\"\" resource-id=\"com.google.android.apps.photos:id/scrolling_toolbar_container\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,312]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/toolbar_container\" class=\"android.widget.LinearLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,312]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/notification_bar_spacer\" class=\"android.view.View\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,136]\" /><node index=\"1\" text=\"\" resource-id=\"com.google.android.apps.photos:id/toolbar\" class=\"android.view.ViewGroup\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,136][1080,312]\"><node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.ImageButton\" package=\"com.google.android.apps.photos\" content-desc=\"Show Navigation Drawer\" checkable=\"false\" checked=\"false\" clickable=\"true\" enabled=\"true\" focusable=\"true\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,147][154,301]\" /><node index=\"1\" text=\"\" resource-id=\"\" class=\"android.view.ViewGroup\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[354,136][726,312]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/product_lockup_view\" class=\"android.view.ViewGroup\" package=\"com.google.android.apps.photos\" content-desc=\"Google Photos\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[354,190][726,259]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/logo\" class=\"android.widget.ImageView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[354,198][541,259]\" /><node index=\"1\" text=\"Photos\" resource-id=\"com.google.android.apps.photos:id/product_name\" class=\"android.widget.TextView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[552,190][726,259]\" /></node></node><node index=\"2\" text=\"\" resource-id=\"\" class=\"android.support.v7.widget.LinearLayoutCompat\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[925,147][1080,301]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/selected_account_disc\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"Sign in\" checkable=\"false\" checked=\"false\" clickable=\"true\" enabled=\"true\" focusable=\"true\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[925,157][1080,290]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/og_selected_account_disc_apd\" class=\"android.widget.FrameLayout\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[925,157][1058,290]\"><node index=\"0\" text=\"\" resource-id=\"com.google.android.apps.photos:id/og_apd_internal_image_view\" class=\"android.widget.ImageView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[931,163][1052,284]\" /><node index=\"1\" text=\"\" resource-id=\"com.google.android.apps.photos:id/og_apd_ring_view\" class=\"android.widget.ImageView\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[931,163][1052,284]\" /></node></node></node></node></node></node></node></node></node></node></node></node></node></node><node index=\"1\" text=\"\" resource-id=\"android:id/statusBarBackground\" class=\"android.view.View\" package=\"com.google.android.apps.photos\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,136]\" /></node></hierarchy>\n, target item description: clickable account disc in the top right"}]} ``` </details>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for contributing an eval!♥️
🚨 Please make sure your PR follows these guidelines, failure to follow the guidelines below will result in the PR being closed automatically. Note that even if the criteria are met, that does not guarantee the PR will be merged nor GPT-4 access be granted. 🚨
PLEASE READ THIS:
In order for a PR to be merged, it must fail on GPT-4. We are aware that right now, users do not have access, so you will not be able to tell if the eval fails or not. Please run your eval with GPT-3.5-Turbo, but keep in mind as we run the eval, if GPT-4 gets higher than 90% on the eval, we will likely reject it since GPT-4 is already capable of completing the task.
We plan to roll out a way for users submitting evals to see the eval performance on GPT-4 soon. Stay tuned! Until then, you will not be able to see the eval performance on GPT-4. Starting April 10, the minimum eval count is 15 samples, we hope this makes it easier to create and contribute evals.
Also, please note that we're using Git LFS for storing the JSON files, so please make sure that you move the JSON file to Git LFS before submitting a PR. Details on how to use Git LFS are available here.
Eval details 📑
Eval name
[Insert Eval name here]
Eval description
[Insert a short description of what your eval does here]
What makes this a useful eval?
[Insert why this eval is worth including and any additional context]
Criteria for a good eval ✅
Below are some of the criteria we look for in a good eval. In general, we are seeking cases where the model does not do a good job despite being capable of generating a good response (note that there are some things large language models cannot do, so those would not make good evals).
Your eval should be:
Basic
evals or theFact
Model-graded eval, or an exhaustive rubric for evaluating answers for theCriteria
Model-graded eval.If there is anything else that makes your eval worth including, please document it below.
Unique eval value
Eval structure 🏗️
Your eval should
evals/registry/data/{name}
evals/registry/evals/{name}.yaml
(For now, we will only be approving evals that use one of the existing eval classes. You may still write custom eval classes for your own cases, and we may consider merging them in the future.)
Final checklist 👀
Submission agreement
By contributing to Evals, you are agreeing to make your evaluation logic and data under the same MIT license as this repository. You must have adequate rights to upload any data used in an Eval. OpenAI reserves the right to use this data in future service improvements to our product. Contributions to OpenAI Evals will be subject to our usual Usage Policies (https://platform.openai.com/docs/usage-policies).
Email address validation
If your submission is accepted, we will be granting GPT-4 access to a limited number of contributors. Access will be given to the email address associated with the commits on the merged pull request.
Limited availability acknowledgment
We know that you might be excited to contribute to OpenAI's mission, help improve our models, and gain access to GPT-4. However, due to the requirements mentioned above and the high volume of submissions, we will not be able to accept all submissions and thus not grant everyone who opens a PR GPT-4 access. We know this is disappointing, but we hope to set the right expectation before you open this PR.
Submit eval
pip install pre-commit; pre-commit install
and have verified thatmypy
,black
,isort
,autoflake
andruff
are running when I commit and pushFailure to fill out all required fields will result in the PR being closed.
Eval JSON data
Since we are using Git LFS, we are asking eval submitters to add in as many Eval Samples (at least 5) from their contribution here:
View evals in JSON
Eval
INSERT_EVAL_HERE