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 26873b0 commit 088a385
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@

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,

```python
from totypes import json_utils

serialized = json_utils.json_from_pytree(params)
with open("my_solution.json", "w") as f:
f.write(serialized)
```

## How to contribute your solutions

- Clone this repository
- Add your solution to the appropriate directory, following the filename convention i.e. `challenges/{CHALLENGE_NAME}/solutions/{DATE}_{GITHUB_USERNAME}_{SOLUTION_ID}.json`
- Add your solution to the appropriate directory, following the filename convention (e.g. `challenges/{CHALLENGE_NAME}/solutions/{YYMMDD}_{GITHUB_USERNAME}_{SOLUTION_ID}.json`)
- Modify the `README.md` in the challenge directory to include your submission. Please link any publication or code that is relevant.
- Run `python scripts/eval.py`, which will detect new designs and add them to the appropriate leaderboard files
- Submit a PR for review

0 comments on commit 088a385

Please sign in to comment.