Skip to content

Commit 6da4d8d

Browse files
authored
Update README.md
1 parent 9d86d65 commit 6da4d8d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ pip install sotabench-eval
2929

3030
You should read the [full documentation here](https://paperswithcode.github.io/sotabench-eval/index.html), which contains guidance on getting started and connecting to [sotabench](https://www.sotabench.com).
3131

32-
Integration is lightweight. For example, if you are evaluating an ImageNet model, you initialize an Evaluator object and (optionally) link to the paper where the model originated from to compare with published results:
32+
Integration is lightweight. For example, if you are evaluating an ImageNet model, you initialize an Evaluator object and (optionally) link to any linked paper:
3333

3434
```python
3535
from sotabencheval.image_classification import ImageNetEvaluator
@@ -38,13 +38,13 @@ evaluator = ImageNetEvaluator(
3838
paper_arxiv_id='1906.06423')
3939
```
4040

41-
Then for each batch of predictions your model makes on ImageNet, you would pass a dictionary of keys as image IDs and values as a `np.ndarray`s of logits for each class to the `evaluator.add` method:
41+
Then for each batch of predictions your model makes on ImageNet, pass a dictionary of keys as image IDs and values as a `np.ndarray`s of logits to the `evaluator.add` method:
4242

4343
```python
4444
evaluator.add(output_dict=dict(zip(image_ids, batch_output)))
4545
```
4646

47-
This logic just needs to be written in a `sotabench.py` file (which contains whatever evaluation logic you need - e.g loading and processing the data), and sotabench will run it on each commit and record the results:
47+
The evaluation logic just needs to be written in a `sotabench.py` file and sotabench will run it on each commit and record the results:
4848

4949
<img width=500 src="/docs/docs/img/results.png">
5050

0 commit comments

Comments
 (0)