Add instructions for benchmarking

BirkhoffG · Aug 28, 2024 · fa50357 · fa50357
1 parent 563e56c
commit fa50357
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -0,0 +1,18 @@
+# Benchmarking Scripts
+
+This directory hosts scripts for benchmarking recourse methods.
+
+## Installation
+
+To install the necessary dependencies, run the following command:
+```sh
+pip install "jax-relax[dev]"
+```
+
+## Usage
+
+To reproduce the results in the paper, you can run
+
+```sh
+python -m benchmarks.built-in.run_all
+```