From c1bb13becc4f8a66e8378e8201b4f12ad8cc9159 Mon Sep 17 00:00:00 2001 From: Connor Olding Date: Sun, 7 May 2023 07:38:06 -0700 Subject: [PATCH] update readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a370f03..cb69734 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ -hey +# thursday + +what comes after [humpday?](https://github.com/microprediction/humpday) **note:** i have a personal bias against bayesian optimizers. these results may not represent them fairly (or at all). +## usage + ``` python3 -m thursday ``` + +## prerequesites + +* Python 3.10 or greater +* *TODO* + +## structure + +* `thursday/candidates` contains wrappers around optimizers to minimize objective functions on the unit cube +* `thursday/external` contains code written by other authors (note their licenses!) +* `thursday/internal` contains original implementations of general-purpose optimizers +* `thursday/solutions` is responsible for generating `thursday/go_benchmark_lists.py` +* `thursday/utilities` contains no surprises +* `thursday/` contains everything else (for now)