Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mfschubert authored Jul 9, 2024
1 parent 088a385 commit 9e42bb1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The leaderboard repo tracks solutions to [invrs-gym](https://github.com/invrs-io/gym) challenges.

Solutions are the `params` which are passed to the `response` method of the component associated wit an gym challenge. They can be saved to json format by,
Solutions are the `params` which are passed to the `response` method of the component associated with a gym challenge. They can be saved to json format by,

```python
from totypes import json_utils
Expand All @@ -12,6 +12,8 @@ with open("my_solution.json", "w") as f:
f.write(serialized)
```

The evaluation metrics include the `eval_metric` scalar associated with each challenge, and the minimum width and spacing measured using the [imageruler](https://github.com/NanoComp/imageruler) algorithm.

## How to contribute your solutions

- Clone this repository
Expand Down

0 comments on commit 9e42bb1

Please sign in to comment.