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

[evals] Refactor evals package to expose completion_fn. #515

Merged
merged 23 commits into from
Apr 11, 2023

Commits on Mar 29, 2023

  1. [evals] Refactor evals package to expose completion_fn.

    PAIR=jasonwei
    
    Co-authored-by: Jason Wei <[email protected]>
    hwchung27 and jasonwei20 committed Mar 29, 2023
    Configuration menu
    Copy the full SHA
    d87a056 View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2023

  1. Add record_raw_samples

    hwchung27 committed Apr 2, 2023
    Configuration menu
    Copy the full SHA
    d9c1395 View commit details
    Browse the repository at this point in the history

Commits on Apr 5, 2023

  1. Andrew/evals refactor (#579)

    # 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
    [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:
    
    - [ ] 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.
    - [ ] Contains failures where a human can do the task, but either GPT-4
    or GPT-3.5-Turbo could not.
    - [ ] 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.
    - [ ] 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
    - [ ] Check that your data is in `evals/registry/data/{name}`
    - [ ] Check that your yaml is registered at
    `evals/registry/evals/{name}.yaml`
    - [ ] 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).
    
    - [ ] 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.
    
    - [ ] 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.
    
    - [ ] 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
    
    - [ ] I have filled out all required fields in the evals PR form
    - [ ] (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
      INSERT_EVAL_HERE
      ```
    </details>
    andrew-openai committed Apr 5, 2023
    Configuration menu
    Copy the full SHA
    a1c6207 View commit details
    Browse the repository at this point in the history
  2. update manifest and pyproject to support fetching data on pip install (

    …#592)
    
    This supports downloading all data on pip install from git, e.g. `pip
    install git+https://github.com/openai/evals.git@main`
    andrew-openai committed Apr 5, 2023
    Configuration menu
    Copy the full SHA
    deb29d3 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    9b1c350 View commit details
    Browse the repository at this point in the history
  4. refactor simple evals to not use result.prompt (#593)

    # 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
    [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:
    
    - [ ] 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.
    - [ ] Contains failures where a human can do the task, but either GPT-4
    or GPT-3.5-Turbo could not.
    - [ ] 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.
    - [ ] 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
    - [ ] Check that your data is in `evals/registry/data/{name}`
    - [ ] Check that your yaml is registered at
    `evals/registry/evals/{name}.yaml`
    - [ ] 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).
    
    - [ ] 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.
    
    - [ ] 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.
    
    - [ ] 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
    
    - [ ] I have filled out all required fields in the evals PR form
    - [ ] (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
      INSERT_EVAL_HERE
      ```
    </details>
    andrew-openai committed Apr 5, 2023
    Configuration menu
    Copy the full SHA
    c470d52 View commit details
    Browse the repository at this point in the history

Commits on Apr 6, 2023

  1. Configuration menu
    Copy the full SHA
    b691cfa View commit details
    Browse the repository at this point in the history
  2. Replace ModelSpecs with CompletionFn (#594)

    Replace ModelSpec with CompletionFn and allow users to specify
    CompletionFn instances from the CLI.
    
    Testing done:
    
    ```
    oaievalset dummy test --max_samples 1
    oaievalset gpt-3.5-turbo test --max_samples 1
    oaievalset testing test --max_samples 1
    ```
    
    ---------
    
    Co-authored-by: Andrew Kondrich <[email protected]>
    jwang47 and andrew-openai committed Apr 6, 2023
    Configuration menu
    Copy the full SHA
    7266049 View commit details
    Browse the repository at this point in the history
  3. Add --registry_path CLI arg (#601)

    - [evals] Refactor evals package to expose `completion_fn`.
    - Add `record_raw_samples`
    - Andrew/evals refactor (#579)
    - update manifest and pyproject to support fetching data on pip install
    (#592)
    - we need to still use the interop for string/list[dicts] for
    modelgraded evals
    - refactor simple evals to not use result.prompt (#593)
    - Clean up duplicate recordings
    - Replace ModelSpecs with CompletionFn (#594)
    - Add --registry_path CLI arg
    
    # 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
    [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:
    
    - [ ] 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.
    - [ ] Contains failures where a human can do the task, but either GPT-4
    or GPT-3.5-Turbo could not.
    - [ ] 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.
    - [ ] 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
    - [ ] Check that your data is in `evals/registry/data/{name}`
    - [ ] Check that your yaml is registered at
    `evals/registry/evals/{name}.yaml`
    - [ ] 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).
    
    - [ ] 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.
    
    - [ ] 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.
    
    - [ ] 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
    
    - [ ] I have filled out all required fields in the evals PR form
    - [ ] (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
      INSERT_EVAL_HERE
      ```
    </details>
    jwang47 committed Apr 6, 2023
    Configuration menu
    Copy the full SHA
    b2a45cf View commit details
    Browse the repository at this point in the history

Commits on Apr 7, 2023

  1. Configuration menu
    Copy the full SHA
    924d2d4 View commit details
    Browse the repository at this point in the history
  2. rm sample freeform, some docs (#603)

    # 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
    [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:
    
    - [ ] 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.
    - [ ] Contains failures where a human can do the task, but either GPT-4
    or GPT-3.5-Turbo could not.
    - [ ] 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.
    - [ ] 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
    - [ ] Check that your data is in `evals/registry/data/{name}`
    - [ ] Check that your yaml is registered at
    `evals/registry/evals/{name}.yaml`
    - [ ] 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).
    
    - [ ] 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.
    
    - [ ] 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.
    
    - [ ] 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
    
    - [ ] I have filled out all required fields in the evals PR form
    - [ ] (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
      INSERT_EVAL_HERE
      ```
    </details>
    andrew-openai committed Apr 7, 2023
    Configuration menu
    Copy the full SHA
    4401cce View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    013d636 View commit details
    Browse the repository at this point in the history

Commits on Apr 10, 2023

  1. Configuration menu
    Copy the full SHA
    08062bc View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    3367006 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    5e71a76 View commit details
    Browse the repository at this point in the history
  4. inner monologue example (#610)

    Inner monologue CoT increase 3.5 accuracy on `born-first` from 63% ->
    93%
    andrew-openai committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    e621b6f View commit details
    Browse the repository at this point in the history
  5. Update README.md

    andrew-openai committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    49d17ed View commit details
    Browse the repository at this point in the history
  6. Update run-evals.md

    andrew-openai committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    1bfba77 View commit details
    Browse the repository at this point in the history
  7. cleanup

    andrew-openai committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    b018aff View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    5222f2c View commit details
    Browse the repository at this point in the history
  9. get oaieval to run

    andrew-openai committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    9db703d View commit details
    Browse the repository at this point in the history

Commits on Apr 11, 2023

  1. address comments

    andrew-openai committed Apr 11, 2023
    Configuration menu
    Copy the full SHA
    02bc2cb View commit details
    Browse the repository at this point in the history
  2. bump version

    andrew-openai committed Apr 11, 2023
    Configuration menu
    Copy the full SHA
    50114a5 View commit details
    Browse the repository at this point in the history