Skip to content

Commit

Permalink
icelandic gec eval (openai#1400)
Browse files Browse the repository at this point in the history
# 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

icelandic-sentences-gec - Grammatical error correction for Icelandic
sentences

### Eval description

The eval contains Icelandic sentences with and without grammatical
errors, spelling errors or other linguistic errors. There are a total of
200 sentences, 100 with errors and 100 where these same errors have been
corrected. The model then predicts whether a particular sentence
contains an error or not, and accuracy is measured.

### What makes this a useful eval?

This is a good measure of the ability of a model to correct grammatical
errors in the Icelandic language. The sentences contain errors which go
against Icelandic language standards, and which a language expert of
Icelandic would correct before a text is published. In addition, it can
serve to measure the general linguistic competence of Icelandic. The
sentences are sourced from the web, and the test set of the Icelandic
Error Corpus (IceEC), which can be freely used.

## 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 commits on 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 `mypy`, `black`,
`isort`, `autoflake` and `ruff` 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
{"input": [{"role": "system", "content": "Þú ert sérfræðingur í
íslensku. Þú færð málsgrein á íslensku sem annaðhvort inniheldur
villu(r) eða ekki. Ef málsgreinin inniheldur málfræðivillu,
stafsetningarvillu eða aðra málfarsvillu sem ætti að leiðrétta, skrifaðu
'rangt'. Ef málsgreinin er villulaus skaltu skrifa 'rétt'. Þú verður að
gefa svar og 'rangt' og 'rétt' eru einu valkostirnir."}, {"role":
"user", "content": "Leiksviðið átti svo hug hans allann við heimkomuna,
og árið 1961 hófst sjónvarpsferill hans."}], "ideal": ["rangt",
"Rangt"]}
{"input": [{"role": "system", "content": "Þú ert sérfræðingur í
íslensku. Þú færð málsgrein á íslensku sem annaðhvort inniheldur
villu(r) eða ekki. Ef málsgreinin inniheldur málfræðivillu,
stafsetningarvillu eða aðra málfarsvillu sem ætti að leiðrétta, skrifaðu
'rangt'. Ef málsgreinin er villulaus skaltu skrifa 'rétt'. Þú verður að
gefa svar og 'rangt' og 'rétt' eru einu valkostirnir."}, {"role":
"user", "content": "Baráttusamtök frumbyggja í Hondúras, sem Caceres
átti þátt í að stofna, fagnaði dómsúrskurðinum í gær og sagði hann sigur
fyrir þjóðir Hondúras."}], "ideal": ["rangt", "Rangt"]}
{"input": [{"role": "system", "content": "Þú ert sérfræðingur í
íslensku. Þú færð málsgrein á íslensku sem annaðhvort inniheldur
villu(r) eða ekki. Ef málsgreinin inniheldur málfræðivillu,
stafsetningarvillu eða aðra málfarsvillu sem ætti að leiðrétta, skrifaðu
'rangt'. Ef málsgreinin er villulaus skaltu skrifa 'rétt'. Þú verður að
gefa svar og 'rangt' og 'rétt' eru einu valkostirnir."}, {"role":
"user", "content": "Sú var naumast býsperrt."}], "ideal": ["rangt",
"Rangt"]}
{"input": [{"role": "system", "content": "Þú ert sérfræðingur í
íslensku. Þú færð málsgrein á íslensku sem annaðhvort inniheldur
villu(r) eða ekki. Ef málsgreinin inniheldur málfræðivillu,
stafsetningarvillu eða aðra málfarsvillu sem ætti að leiðrétta, skrifaðu
'rangt'. Ef málsgreinin er villulaus skaltu skrifa 'rétt'. Þú verður að
gefa svar og 'rangt' og 'rétt' eru einu valkostirnir."}, {"role":
"user", "content": "Fólk er beðið um að fylgjast vel með veðurspám þar
sem breytingar gætu orðið þegar nær dregur."}], "ideal": ["rétt",
"Rétt"]}
{"input": [{"role": "system", "content": "Þú ert sérfræðingur í
íslensku. Þú færð málsgrein á íslensku sem annaðhvort inniheldur
villu(r) eða ekki. Ef málsgreinin inniheldur málfræðivillu,
stafsetningarvillu eða aðra málfarsvillu sem ætti að leiðrétta, skrifaðu
'rangt'. Ef málsgreinin er villulaus skaltu skrifa 'rétt'. Þú verður að
gefa svar og 'rangt' og 'rétt' eru einu valkostirnir."}, {"role":
"user", "content": "Gjaldmiðlasamningunum var ætlað að tryggja að Exista
gæti keypt gjaldeyri á fyrir fram ákveðnum dagsetningum á fyrir fram
ákveðnu gengi svo að félagið gæti greitt af skuldum sínum í erlendri
mynt með þeim hagnaði sem til varð í íslenskum krónum eins og segir í
grein Lýðs."}], "ideal": ["rétt", "Rétt"]}
  ```
</details>
  • Loading branch information
svanhvitlilja authored Jan 10, 2024
1 parent d628eb3 commit 5c6c57d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
3 changes: 3 additions & 0 deletions evals/registry/data/icelandic-sentences-gec/samples.jsonl
Git LFS file not shown
9 changes: 9 additions & 0 deletions evals/registry/evals/icelandic-sentences-gec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
icelandic-sentences-gec:
id: icelandic-sentences-gec.dev.v0
description: Test the model's ability to correctly identify whether an Icelandic sentence contains a grammatical error.
metrics: [accuracy]

icelandic-sentences-gec.dev.v0:
class: evals.elsuite.basic.match:Match
args:
samples_jsonl: icelandic-sentences-gec/samples.jsonl

0 comments on commit 5c6c57d

Please sign in to comment.