diff --git a/README.md b/README.md
index d84984f..dfed34b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
# Hyperoptax: Parallel hyperparameter tuning with JAX
@@ -6,8 +6,6 @@

[](https://codecov.io/gh/TheodoreWolf/hyperoptax)
->[!WARNING]
-> Hyperoptax is still a WIP and the API is subject to change. There are _many_ rough edges to smooth out. It is recommended to download specific versions or to download from source if you want to use it in a large scale project.
## ⛰️ Introduction
@@ -33,7 +31,7 @@ pip install --upgrade "jax[cpu]"
```
## 🥜 In a nutshell
-All optimizers follow the same stateless pattern: `Optimizer.init` returns a `(state, optimizer)` pair, and `optimizer.optimize` runs the search loop. Your objective function must have the signature `fn(key, params) -> scalar`. `params` can be any PyTree.
+All optimizers follow the same stateless pattern: `Optimizer.init` returns a `(state, optimizer)` pair, and `optimizer.optimize` runs the search loop. Your objective function must have the signature `fn(key, params) -> scalar`. Importantly, `params` can be _any_ PyTree.
```python
import jax
@@ -117,7 +115,7 @@ Since we are working in pure JAX the same [sharp bits](https://docs.jax.dev/en/l
We welcome pull requests! To get started:
1. Open an issue describing the bug or feature.
-2. Fork the repository and create a feature branch (`git checkout -b my-feature`).
+2. Fork the repository and create a feature branch (`git checkout -b user/my-feature`).
3. Clone and install dependencies. We recommend [uv](https://docs.astral.sh/uv/) for environment management:
```bash
@@ -140,6 +138,7 @@ I'm developing this both as a passion project and for my work in my PhD. I have
- Callbacks!
- Reduce redundant kernel recomputation — currently the full K matrix is rebuilt each iteration when only the new row/column is needed.
- Length scale tuning currently uses a fixed Adam step count; smarter convergence criteria could help.
+- Tree Parzen Estimator (TPE), this is essentially SOTA for hyperparameter search, implementing this would be super cool!
## 📝 Citation
diff --git a/assets/logo-transparent.png b/assets/logo-transparent.png
new file mode 100644
index 0000000..1192243
Binary files /dev/null and b/assets/logo-transparent.png differ
diff --git a/assets/logo.png b/assets/logo.png
index e84858c..be193d5 100644
Binary files a/assets/logo.png and b/assets/logo.png differ
diff --git a/assets/logo_transparent.png b/assets/logo_transparent.png
deleted file mode 100644
index 60517bc..0000000
Binary files a/assets/logo_transparent.png and /dev/null differ
diff --git a/pyproject.toml b/pyproject.toml
index bad097a..c279b20 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -34,7 +34,7 @@ dev = [
# Complete development environment
all = [
- "hyperoptax[notebooks,testing,dev]"
+ "hyperoptax[notebooks,testing,dev,docs]"
]
[tool.setuptools.packages.find]