Skip to main content

biogeme-optimization

PyPi

Various optimization algorithms used for teaching and research. In particular, they are used by Biogeme.

Biogeme-facing optimizer API

The optimizer can be installed and used without installing the full biogeme distribution:

uv add biogeme-optimization

The canonical imports are:

from biogeme_optimization.function import FunctionToMinimize
from biogeme_optimization.optimization import bfgs_trust_region_for_biogeme

bfgs_trust_region_for_biogeme accepts an objective, a one-dimensional NumPy initial vector, one bound pair and variable name per parameter, and an options mapping containing maxiter, tolerance, and objective_tolerance. It returns a typed result with solution, convergence, and messages attributes. The result retains its historical three-item tuple shape for Biogeme callers; resumable state is exposed as the separate result.state attribute.

The trust-region BFGS path requires only objective and gradient evaluation; implementing a Hessian is optional. The historical bounds argument remains part of the API, although this particular legacy trust-region BFGS algorithm does not enforce finite bounds. The package does not import or depend on the full biogeme distribution.

Resumable trust-region BFGS

The Biogeme-facing trust-region BFGS entry point accepts a TrustRegionBFGSState through state= and returns the final state as result.state. State schema version 1 records the current objective and gradient, BFGS approximation, model history, trust-region radius, cumulative iteration/evaluation counters, convergence status, objective scaling, and the algorithm options. state.to_dict() is JSON-compatible; state.to_npz() and TrustRegionBFGSState.from_npz() provide an efficient binary representation for large Hessian matrices.

checkpoint_callback receives a deep immutable snapshot after initialization, after every rejected or accepted trust-region boundary, and immediately before convergence, interruption, or an iteration-limit return. stop_requested() can request a resumable checkpoint_requested return. Existing calls without state retain the legacy numerical behavior, and the optimizer requires only the objective/gradient protocol; the full biogeme package is not required.

The package contains the following modules:

algebra

It contains functions dealing with linear algebra:

  • A modified Cholesky factorization introduced by Schnabel and Eskow (1999)
  • The calculation of a descent direction based on this factorization.

bfgs

The functions in this module calculate

  • the BFGS update of the hessian approximation (see Eq. (13.12) in Bierlaire (2015)),
  • the inverse BFGS update of the hessian approximation (see Eq. (13.13) in Bierlaire (2015)).

bounds

This module mainly defines the class Boundsthat manages the bound constraints.

diagnostics

This module defines the diagnostic of some optimization subproblems (dogleg, and comjugate gradient).

exceptions

It defines the OptimizationError exception.

format

It defines the class FormattedColumns that formats the information reported at each iteration of an algorithm.

function

It defines the abstract class FunctionToMinimize that encapsulate the calculation of the objective function and its derivatives.

hybrid_function

It defines the class HybridFunction that calculates the objective function and its derivatives, where the second derivative can be either the analytical hessian, or a BFGS approximation.

linesearch

This module implements the line search algorithms (see Chapter 11 in Bierlaire, 2015).

simple_bounds

This module implements the minimization algorithm under bound constraints proposed by Conn et al. (1988).

trust_region

This module implements the trust region algorithms (see Chapter 12 in Bierlaire, 2015).

References

Metadata

Release files for biogeme-optimization 0.0.14

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for biogeme-optimization 0.0.14
File Size Uploaded
biogeme_optimization-0.0.14.tar.gz 86.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for biogeme-optimization 0.0.14
File Interpreter ABI Platform
biogeme_optimization-0.0.14-py3-none-any.whl Python 3 none any Details

Total release size: 170.1 kB

Release files / biogeme_optimization-0.0.14.tar.gz

Download URL biogeme_optimization-0.0.14.tar.gz
Size 86.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9be0b1e2de0bf52b45bc05bdbb2d6bbc14849a4217724db2c902dc6f22561c81
BLAKE2b-256 checksum
How to use checksums
68486d92be3536bd5110c36b22a340540d78789e5b72f82344100efd3eabad09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / biogeme_optimization-0.0.14-py3-none-any.whl

Download URL biogeme_optimization-0.0.14-py3-none-any.whl
Size 83.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bf9fa5714e6343e45c8a16a87411daa78969e706b5072000b8753af81106c36a
BLAKE2b-256 checksum
How to use checksums
4e8861055b769321105c6449bc9908a80628c8cfab8b6b7d6659bef1cf57ee65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page