docs(optimizr): add logo and fix rtd deps

2026-02-09 16:15:41 +01:00
parent c1f4c0bde7
commit 43af949904
28 changed files with 805 additions and 220 deletions
@@ -0,0 +1,21 @@
+# API: mcmc_sample
+
+```python
+from optimizr import mcmc_sample
+
+samples = mcmc_sample(
+    log_likelihood_fn,
+    data,
+    initial_params,
+    param_bounds,
+    n_samples=10000,
+    burn_in=1000,
+    proposal_std=0.1,
+)
+```
+
+- `log_likelihood_fn(params, data) -> float`
+- `data`: np.ndarray passed through to the likelihood
+- `initial_params`: np.ndarray starting point
+- `param_bounds`: list of `(min, max)` tuples
+- Returns `samples: np.ndarray` of shape `(n_samples, n_params)`