Skip to content

Commit ebf61f9

Browse files
alexnodelandclaude
andcommitted
Rebrand README with the e mark and align content with the redesign
Adds the branded header from the redesign: the Fraunces-rendered green e tile mark, the evo.fugue.run hero tagline, and a badge row. Adds a Documentation section (user guide, playground, docs.rs), fixes the Fugue link to the real repo (alexnodeland/fugue, not the stale fugue-ppl org), and updates the Development section's fugue-ppl version references from 0.1.0 to the actual 0.2.0. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018yo1jdkckG7yQ9eBqLbaDB
1 parent b403dc8 commit ebf61f9

2 files changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1-
# fugue-evo
1+
<div align="center">
22

3-
A broad evolutionary-computation library for Rust, with an optional probabilistic-programming bridge to [Fugue](https://github.com/fugue-ppl/fugue).
3+
<img src="assets/fugue-evo-mark.png" alt="Fugue Evo" width="140" height="140">
4+
5+
# Fugue Evo
6+
7+
**Evolution as Bayesian inference — a probabilistic, type-safe evolutionary computation library for Rust**
8+
9+
*Populations hunting real landscapes, live in your browser: every figure in the docs at [evo.fugue.run](https://evo.fugue.run) runs the actual crate, compiled to WASM.*
10+
11+
[![Crates.io](https://img.shields.io/crates/v/fugue-evo.svg)](https://crates.io/crates/fugue-evo)
12+
[![Dev Docs](https://docs.rs/fugue-evo/badge.svg)](https://docs.rs/fugue-evo)
13+
[![User Docs](https://img.shields.io/badge/guides-evo.fugue.run-blue)](https://evo.fugue.run)
14+
[![CI](https://github.com/alexnodeland/fugue-evo/actions/workflows/ci.yml/badge.svg)](https://github.com/alexnodeland/fugue-evo/actions/workflows/ci.yml)
15+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
16+
17+
</div>
18+
19+
A broad evolutionary-computation library for Rust, with an optional probabilistic-programming bridge to [Fugue](https://github.com/alexnodeland/fugue).
420

521
The default flagship algorithms (SimpleGA, CMA-ES, NSGA-II, Island Model, Evolution Strategy, EDA/UMDA, SteadyState) are standalone evolutionary computation: they use Fugue's `Trace` only as an address→value data container for the optional `to_trace`/`from_trace` round-trip, not for inference. The genuine "evolution as Bayesian inference over solution spaces" story — a tempered Sequential Monte Carlo pipeline over Fugue's `Model`/`Handler`/`factor` machinery — lives in the `fugue_integration` module (`EvolutionarySMC`/`EvolutionStep`/`BayesianAdaptiveGA`), demonstrated by `examples/bayesian_evolution.rs`. Reach for that module, not the default algorithms, when you want the PPL-powered inference path (EV-17).
622

@@ -70,6 +86,12 @@ Run an example:
7086
cargo run --example sphere_optimization
7187
```
7288

89+
## Documentation
90+
91+
- **[User Guide](https://evo.fugue.run/)** - Tutorials, how-to guides, and reference, with live WASM-backed figures throughout
92+
- **[Playground](https://evo.fugue.run/playground.html)** - Drive all five algorithms in the browser: SimpleGA, CMA-ES, NSGA-II, islands, UMDA
93+
- **[API Reference](https://docs.rs/fugue-evo)** - Complete API documentation
94+
7395
## Core Concepts
7496

7597
### Fitness as Likelihood
@@ -132,7 +154,7 @@ crates were never exercised against together:
132154

133155
```toml
134156
[dependencies]
135-
fugue-ppl = { path = "../fugue", version = "0.1.0" }
157+
fugue-ppl = { path = "../fugue", version = "0.2.0" }
136158
```
137159

138160
Both crates live side by side under the same `fugue-ecosystem` parent
@@ -141,15 +163,15 @@ committed default once `fugue`'s own 2026-07 audit remediation landed with a
141163
green full-test gate; earlier in the remediation the sibling checkout was
142164
frequently mid-edit and momentarily uncompilable, which is why the dependency
143165
had been pinned to the published registry release until the sibling stabilized.
144-
The `version = "0.1.0"` field is honored if `fugue-ppl` is ever resolved from
166+
The `version = "0.2.0"` field is honored if `fugue-ppl` is ever resolved from
145167
crates.io instead (e.g. the sibling checkout is absent).
146168

147169
To build against the published crates.io release rather than your local
148170
`../fugue` checkout, replace the dependency with:
149171

150172
```toml
151173
[dependencies]
152-
fugue-ppl = "0.1.0"
174+
fugue-ppl = "0.2.0"
153175
```
154176

155177
Run `cargo check` after switching either way to confirm the resolved `fugue`

assets/fugue-evo-mark.png

16.9 KB
Loading

0 commit comments

Comments
 (0)