From acff2d862b4561d1c00f068bf8d3543e84f2e2da Mon Sep 17 00:00:00 2001 From: Martin Schubert Date: Tue, 9 Jul 2024 11:55:46 -0700 Subject: [PATCH] update readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 9a61078..1db4dff 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ # leaderboard + +The leaderboard repo tracks solutions to [invrs-gym](https://github.com/invrs-io/gym) challenges. + +## 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` +- 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