Skip to content

Results

Inspect the result of an optimization. X contains decision variables and F contains their objective values; persistence has its own reference.

Stable public API. The 1.x compatibility policy defines the supported surface; import from the public facade shown below.

from vamos import OptimizationResult, StudyResult

Understand an optimization result · Quickstart · Save and replay a run · Durable study reports

Do not infer the number or source of returned solutions from population size alone. OptimizationResult.front() Pareto-filters the current top-level F; it does not switch result sources. Consult the algorithm/result-mode contract when choosing between a population, non-dominated results, and an external archive.

OptimizationResult

Container returned by optimize() with Pareto front data and selection helpers.

Use vamos.ux.api for summaries, plotting, and export helpers.

manifest property

Immutable source manifest when this result was loaded from a run.

StudyResult

Bases: Sequence[OptimizationResult]

Container returned by optimize(..., seed=[...]).

The object behaves like a read-only sequence of :class:OptimizationResult while also exposing light-weight aggregation helpers for numeric metrics.

runs property

Return the underlying immutable run collection.

best_run(name, maximize=True)

Return the run with the best value for the named metric.

mean(name)

Return the mean of a numeric metric across runs.

metric_values(name)

Return a float array with the named metric extracted from each run.

std(name)

Return the population standard deviation of a numeric metric across runs.