evals icon indicating copy to clipboard operation
evals copied to clipboard

add eval : keyboard-key-matching

Open developerelgen opened this issue 1 year ago β€’ 2 comments

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

Eval details πŸ“‘

Eval name

Keyboard Key Matching

Eval description

Keyboard Key Matching evaluation asks about the position of each KEY and various key combinations. Since there are various types of keyboards and different function keys exist on each keyboard, this data is based on the MacOS keyboard with standard keys.

What makes this a useful eval?

Keyboard is one of the interfaces that connect the physical world and computers through the process of typing. Through Keyboard Key Matching, ChatGPT can assist visually impaired individuals in learning computer typing. Additionally, by simulating the keyboard, it can help users efficiently and quickly perform coding tasks and use various software programs by implementing shortcuts as text and registering new shortcuts or macros.

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

Insert what makes your eval high quality that was not mentioned above. (Not required)

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 acknowledgement

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

Submit eval

  • [x] I have filled out all required fields in the evals PR form
  • [x] (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:

View evals in JSON

Eval

{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located to the right of the left Shift key?"}], "ideal": "z"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located to the left of the z key?"}], "ideal": "Left Shift"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located above of the down arrow key?"}], "ideal": "up arrow"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located to the left of the down arrow key?"}], "ideal": "left arrow"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located to the left of the right arrow key?"}], "ideal": "down arrow"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is located to the right of the down arrow key?"}], "ideal": "right arrow"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What character is typed by pressing the Shift key and the left square bracket key?"}], "ideal": "{"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What character is typed by pressing the Shift key and the right square bracket key?"}], "ideal": "}"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What character is typed by pressing the Shift key and the backslash key?"}], "ideal": "|"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is used to enter the '!' symbol on a macOS keyboard?"}], "ideal": "Shift + 1"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is used to enter the '@' symbol on a macOS keyboard?"}], "ideal": "Shift + 2"}
{"input": [{"role": "system", "content": "You can help visually impaired individuals learn a macOS keyboard or simulate a macOS keyboard to register or execute shortcuts. When answering, you only need to mention the keyboard key or shortcut combination without additional explanation."}, {"role": "user", "content": "What key is used to enter the '#' symbol on a macOS keyboard?"}], "ideal": "Shift + 3"}

developerelgen avatar Apr 25 '23 04:04 developerelgen

Related PR:

  • #693

Ein-Tim avatar Apr 25 '23 05:04 Ein-Tim

Related PR:

#693 seems to simply focus on understanding the position, whereas this PR is more complex and better as it considers multiple key combinations and shortcuts.

developerelgen avatar Apr 25 '23 05:04 developerelgen

Closing the PR due to inactivity; please reopen if you get a chance to address comments.

usama-openai avatar Jun 13 '23 20:06 usama-openai