notwa/thursday
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Connor Olding 2023-05-07 07:38:06 -07:00
parent 6114ccbd40
commit c1bb13becc
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -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)