feat: add README.md with project overview, features, quick start guide, and documentation links

2026-01-30 17:33:33 +01:00
parent 6ab023dcea
commit e95755dd82
1 changed files with 46 additions and 0 deletions
@@ -0,0 +1,46 @@
+# optimize
+
+A Rust library for black-box optimization using Tree-Parzen Estimator (TPE).
+
+[![Docs](https://docs.rs/optimize/badge.svg)](https://docs.rs/optimize)
+[![Crates.io](https://img.shields.io/crates/v/optimize.svg)](https://crates.io/crates/optimize)
+
+## Features
+
+- Optuna-like API for hyperparameter optimization
+- Float, integer, and categorical parameter types
+- Log-scale and stepped parameter sampling
+- Sync and async optimization with parallel trial evaluation
+- Serialization support for saving/loading study state
+
+## Quick Start
+
+```rust
+use optimize::{Direction, Study, TpeSampler};
+
+let sampler = TpeSampler::builder().seed(42).build();
+let study: Study<f64> = Study::with_sampler(Direction::Minimize, sampler);
+
+study
+    .optimize_with_sampler(20, |trial| {
+        let x = trial.suggest_float("x", -10.0, 10.0)?;
+        Ok::<_, optimize::TpeError>(x * x)
+    })
+    .unwrap();
+
+let best = study.best_trial().unwrap();
+println!("Best value: {} at x={:?}", best.value, best.params);
+```
+
+## Feature Flags
+
+- `serde` - Enable serialization/deserialization of studies and trials
+- `async` - Enable async optimization methods (requires tokio)
+
+## Documentation
+
+Full API documentation is available at [docs.rs/optimize](https://docs.rs/optimize).
+
+## License
+
+MIT