dspy_rs::optimizer

Generated from rustdoc JSON at dspy-rs v0.7.3 (commit b5da857). Do not edit by hand; regenerate with python3 docs/scripts/gen_api.py (see the script header for the rustdoc commands). Item links lead to full signatures and method docs on docs.rs.

Automatic prompt optimization.

Re-exports

Item	Description
`bootstrap::*`	Glob re-export.
`copro::*`	Glob re-export.
`engine::*`	Glob re-export.
`gepa::*`	Glob re-export.
`mipro::*`	Glob re-export.
`pareto::*`	Glob re-export.
`program_engine::*`	Glob re-export.
`simba::*`	Glob re-export.

Modules

Item	Description
`bootstrap`	BootstrapFewShot: the minimal end-to-end exercise of the optimizer contract (vision §5.
`copro`
`engine`	The shared evaluation engine (vision §5.4): every optimizer is a thin strategy over this core.
`gepa`
`mipro`
`pareto`
`program_engine`	The IR-native evaluation path (RFC 0002 IR-6): candidate `Overlay`s evaluated over one shared `Arc<Program>` through the `Interpreter` with candidate-level parallelism.
`simba`	SIMBA: Stochastic Introspective Mini-Batch Ascent (vision §4.3) — the cheap agentic default.

Traits

Item	Description
`Optimizer`	Tunes a module’s `Predict` leaves for better performance.

`optimizer::bootstrap`

BootstrapFewShot: the minimal end-to-end exercise of the optimizer contract (vision §5.

Structs

Item	Description
`BootstrapFewShot`	Few-shot demo bootstrapper — the simplest complete optimizer.
`BootstrapFewShotBuilder`	Use builder syntax to set the inputs and finish with `build()`).
`BootstrapReport`	What a `BootstrapFewShot` run did.

`optimizer::copro`

Structs

Item	Description
`COPRO`	Breadth-first instruction optimizer.
`COPROBuilder`	Use builder syntax to set the inputs and finish with `build()`).

`optimizer::engine`

The shared evaluation engine (vision §5.4): every optimizer is a thin strategy over this core.

Structs

Item	Description
`Budget`	Hard caps on evaluation spend. `None` = unlimited.
`Candidate`	A candidate is data: a named set of `Overlay`s (predictor name → instruction/demos) plus a stable hash (`Candidate::stable_hash`).
`CandidateEval`	A candidate’s results over one evaluation batch, in request order.
`CandidateUndo`	Saved pre-overlay state for the predictors a candidate touched. Produced by `apply_candidate`, consumed by `restore_candidate`.
`EngineConfig`	Engine tuning knobs.
`EvalEngine`	The shared evaluation core (vision §5.4).
`Overlay`	A per-predictor parameter overlay: which optimizable values to install.
`ParetoView`	Dominance snapshot computed from a `ScoreMatrix`: which candidates win (or tie, within tolerance) on at least one example.
`RolloutCache`	In-memory rollout cache: `(baseline, candidate, example, salt)` → `Eval`.
`RolloutOutcome`	One evaluated (or cache-served) rollout.
`ScoreMatrix`	Per-instance score matrix: candidates × examples.
`Spend`	What the engine has consumed so far. Serialized into checkpoints and reported to strategies.

Enums

Item	Description
`EvalOutcome`	Result of `EvalEngine::evaluate`.
`GateOutcome`	Result of `EvalEngine::evaluate_gated`.

Functions

Item	Description
`apply_candidate`	Applies a candidate’s overlays to a module through the single mutation seam (`DynPredictor::apply_update`), returning the undo snapshot.
`restore_candidate`	Restores the pre-candidate state captured by `apply_candidate`.

`optimizer::gepa`

Re-exports

Item	Description
`ParetoStatistics`	Re-export of `super::pareto::ParetoStatistics`.

Structs

Item	Description
`GEPA`	Genetic-Pareto instruction optimizer with feedback-driven evolution.
`GEPABuilder`	Use builder syntax to set the inputs and finish with `build()`).
`GEPACandidate`	A single instruction candidate tracked through GEPA’s evolutionary search.
`GEPAResult`	Full report from a `GEPA` optimization run.
`ReflectOnInstructionOutput`

`optimizer::mipro`

Structs

Item	Description
`MIPROv2`	Trace-guided instruction and demo optimizer.
`MIPROv2Builder`	Use builder syntax to set the inputs and finish with `build()`).
`PromptCandidate`	An instruction candidate with its evaluated score.
`PromptingTips`	Library of general prompting best practices used to seed candidate generation.

`optimizer::pareto`

Structs

Item	Description
`ParetoFrontier`	Per-example dominance frontier for candidate selection.
`ParetoStatistics`	Snapshot of the Pareto frontier at a point in the search.

`optimizer::program_engine`

The IR-native evaluation path (RFC 0002 IR-6): candidate Overlays evaluated over one shared Arc<Program> through the Interpreter with candidate-level parallelism.

Structs

Item	Description
`ProgramEvalEngine`	The shared evaluation core for the dynamic lane: candidate overlays over one interpreter-loaded program.

Enums

Item	Description
`ProgramEvalOutcome`	Result of `ProgramEvalEngine::evaluate_program_candidates`.

Traits

Item	Description
`ProgramMetric`	How a program-lane strategy tells the engine what “good” means: score one interpreter output (`JsonMap` of the program’s output signature fields) against a labeled example.

`optimizer::simba`

SIMBA: Stochastic Introspective Mini-Batch Ascent (vision §4.3) — the cheap agentic default.

Structs

Item	Description
`IntrospectRolloutsOutput`
`SIMBA`	Minibatch introspective ascent — the cheap agentic default (vision §4.3).
`SIMBABuilder`	Use builder syntax to set the inputs and finish with `build()`).
`SimbaReport`	What a `SIMBA` run did.
`SimbaStep`	What one SIMBA step did.

Enums

Item	Description
`SimbaMove`	Which of SIMBA’s two moves a step proposed.

Overview

dspy-rs

Companion crates

dspy_rs::optimizer

Re-exports

Modules

Traits

`optimizer::bootstrap`

Structs

`optimizer::copro`

Structs

`optimizer::engine`

Structs

Enums

Functions

`optimizer::gepa`

Re-exports

Structs

`optimizer::mipro`

Structs

`optimizer::pareto`

Structs

`optimizer::program_engine`

Structs

Enums

Traits

`optimizer::simba`

Structs

Enums

​Re-exports

​Modules

​Traits

​optimizer::bootstrap

​Structs

​optimizer::copro

​Structs

​optimizer::engine

​Structs

​Enums

​Functions

​optimizer::gepa

​Re-exports

​Structs

​optimizer::mipro

​Structs

​optimizer::pareto

​Structs

​optimizer::program_engine

​Structs

​Enums

​Traits

​optimizer::simba

​Structs

​Enums

Re-exports

Modules

Traits

`optimizer::bootstrap`

Structs

`optimizer::copro`

Structs

`optimizer::engine`

Structs

Enums

Functions

`optimizer::gepa`

Re-exports

Structs

`optimizer::mipro`

Structs

`optimizer::pareto`

Structs

`optimizer::program_engine`

Structs

Enums

Traits

`optimizer::simba`

Structs

Enums