Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ezelikman authored Aug 11, 2022
1 parent 25a61e2 commit b119a12
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@ In order to implement new scenarios:
1. Create a new file as a new Python scenario file in the `scenarios` folder.
2. Within the scenario file, create a `Scenario` class, e.g. `YourScenario`.
3. `YourScenario` should implement `get_instances`, a method returning a
list of `Instance` objects which each have a list of (potentially only one)
`Reference` answers. You may have `CORRECT_TAG` in a `Reference` instance's
tags argument, indicating that it is the correct answer. In addition, you
list of `Instance` objects. Each `Instance` must have a list of (potentially one)
`Reference` answers: a correct answer may be indicated with a `CORRECT_TAG` in
a `Reference` instance's `tags` argument. In addition, you
must specify the `split` of the `Instance` as one of `TRAIN_SPLIT`,
`VALID_SPLIT`, or `TEST_SPLIT` constants as in `scenario.py`.
4. Note that you need not enumerate every possible correct answer (nor must
Expand Down

0 comments on commit b119a12

Please sign in to comment.