swaits
fa3f2e8fb0
Theme: documentation and project polish. No public-API changes; this is the v0.5 release that elevates heuropt's docs/onboarding/governance to bar-setting status. Adds: - mdbook user guide at docs/book/ with intro, getting-started, defining-problems, choosing-an-algorithm, cookbook (7 recipes), comparison vs other libraries, stability/SemVer, migration guides. Deploys to https://swaits.github.io/heuropt/ via .github/workflows/ docs.yml. - Runnable rustdoc examples on every algorithm (35 of them), all exercised by cargo test --doc. - Three real-world examples: portfolio.rs (multi-obj with budget constraint), hyperparam_tuning.rs (BO + TPE), scheduling.rs (permutation via SA + SwapMutation against Smith's-rule oracle). - Governance: CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md (adopting builderscode.org's Builder's Code of Conduct), GitHub issue templates, PR template. Polishes: - README hero with badges + user-guide link. - lib.rs crate-level docs. - CHANGELOG entry for 0.5.0. Bumps Cargo.toml to 0.5.0.
41 lines
1.1 KiB
TOML
41 lines
1.1 KiB
TOML
[package]
|
|
name = "heuropt"
|
|
version = "0.5.0"
|
|
edition = "2024"
|
|
rust-version = "1.85"
|
|
authors = ["Stephen Waits <steve@waits.net>"]
|
|
description = "A practical Rust toolkit for heuristic single-, multi-, and many-objective optimization."
|
|
license = "MIT"
|
|
readme = "README.md"
|
|
repository = "https://github.com/swaits/heuropt"
|
|
homepage = "https://github.com/swaits/heuropt"
|
|
documentation = "https://docs.rs/heuropt"
|
|
keywords = ["optimization", "evolutionary", "nsga", "pareto", "moead"]
|
|
categories = ["algorithms", "science", "mathematics", "simulation"]
|
|
|
|
[features]
|
|
default = []
|
|
serde = ["dep:serde"]
|
|
parallel = ["dep:rayon"]
|
|
|
|
[dependencies]
|
|
rand = "0.9"
|
|
rand_distr = "0.5"
|
|
rayon = { version = "1", optional = true }
|
|
serde = { version = "1", features = ["derive"], optional = true }
|
|
|
|
[dev-dependencies]
|
|
gungraun = "0.18"
|
|
proptest = "1"
|
|
|
|
[[bench]]
|
|
name = "hot_paths"
|
|
harness = false
|
|
|
|
# Tighten release codegen for the compare harness and downstream binaries
|
|
# that build heuropt directly (i.e. when this crate is the workspace root).
|
|
# When heuropt is used as a dependency the consumer's profile wins.
|
|
[profile.release]
|
|
lto = "thin"
|
|
codegen-units = 1
|