/evals/.github
šŸ”€ Relocate issue templates to proper directory (#160) šŸ“ The OpenAI/evals repository has a problem with where the issue templates are stored, causing issues for contributors who are trying to create new issues. I am submitting a pull request to move the issue template forms from the .github directory to the ISSUE_TEMPLATE directory, following GitHub's guidelines for configuring issue templates for your repository. This change will improve organization and make it easier for contributors to submit meaningful issues. Please note that this PR is focused solely on moving the issue templates to the correct directory and is not a new eval. For more information on configuring issue templates, see the [GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#:~:text=To%20use%20an%20issue%20form%20in%20your%20repository%2C%20you%20must%20create%20a%20new%20file%20and%20add%20it%20to%20the%20.github/ISSUE_TEMPLATE%20folder%20in%20your%20repository). ^ Witten with GPT4 šŸ„‡ to-do: Submit pull request template for non-eval improvements and recommend .github community repo for OpenAI. # 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. We encourage partial PR's with ~5-10 example that we can then run the evals on and share the results with you so you know how your eval does with GPT-4 before writing all 100 examples. ## Eval details šŸ“‘ ### Eval name **NOT APPLICABLE** : Improvement to repository ### Eval description > **NOT APPLICABLE** : Improvement to repository ### What makes this a useful eval? > **NOT APPLICABLE** : Improvement to repository ## 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 100 high quality examples (it is okay to only contribute 5-10 meaningful examples and have us test them with GPT-4 before adding all 100) 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}.jsonl` - [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: <details> <summary>View evals in JSON</summary> ### Eval ```jsonl [{"OpenAI Evals": "Where art thou?", "TheBoatyMcBoatFace": "Not here say I."}] ``` </details>
2 years ago
Make the torch dep optional (#1524) `torch` was added in https://github.com/openai/evals/pull/1496, but it's very heavy and only required for one eval. Let's move it to an optional-dependency
8 months ago
Update CODEOWNERS to new maintainers (#1431) Update to include new maintainers of the evals repo
a year ago
Initial Commit
2 years ago
Adding ruff, running pre-commit hooks, small fixes and documentation (#1303) This doesn't contribute an Eval but slightly improves the developer experience for contributors.
a year ago