API Reference¶

Find a public function, configuration, or result type without browsing the entire implementation. Signatures and parameter descriptions on the linked pages are generated from Python docstrings.

New to VAMOS? Start with the Quickstart or solve your own problem. For commands rather than Python imports, see CLI and configuration.

Core optimization¶

I need to…	Reference
Run an algorithm	Optimization
Define objectives, bounds, and constraints	Problem definition
Inspect decision variables and objective values	Results
Find supported problem, algorithm, or operator identifiers	Discovery
Set algorithm parameters	Algorithm configuration

Reproducible runs and studies¶

I need to…	Reference
Save, load, verify, or replay a run	Run lifecycle
Inspect a stored run or verification report	Run models
Define and preview an experiment matrix	Study specification and planning
Create, run, resume, or retry a study	Study lifecycle
Inspect study limits, reports, and summaries	Study models

Stability and advanced APIs¶

The references above use the public facades vamos, vamos.algorithms, vamos.run_artifacts, and vamos.study_artifacts. Only the surfaces listed in Stability and versioning and frozen under tests/compatibility/v1_0_0/ have a 1.x compatibility commitment.

Tuning, parameter spaces, and development diagnostics are experimental. Constraint internals, problem adapters and encodings, and generic configuration are implementation references, not stable imports.

Existing bookmarks¶

Old section and symbol bookmarks are forwarded to their new page within the same documentation version. With JavaScript disabled, expand the directory below and follow the corresponding link. Unknown fragments stay on this index.

Legacy bookmark directory