Note
Go to the end to download the full example code.
Mixture of logit modelsΒΆ
- Example of a uniform mixture of logit models, using Monte-Carlo
integration. The mixing distribution is uniform. The draws are from the Modified Hypercube Latin Square.
Michel Bierlaire, EPFL Fri Jun 20 2025, 11:24:34
import biogeme.biogeme_logging as blog
from IPython.core.display_functions import display
from biogeme.biogeme import BIOGEME
from biogeme.expressions import Beta, Draws, MonteCarlo, log
from biogeme.models import logit
from biogeme.results_processing import get_pandas_estimated_parameters
See the data processing script: Data preparation for Swissmetro.
from swissmetro_data import (
CAR_AV_SP,
CAR_CO_SCALED,
CAR_TT_SCALED,
CHOICE,
SM_AV,
SM_COST_SCALED,
SM_TT_SCALED,
TRAIN_AV_SP,
TRAIN_COST_SCALED,
TRAIN_TT_SCALED,
database,
)
logger = blog.get_screen_logger(level=blog.INFO)
logger.info('Example b06unif_mixture_MHLS')
Example b06unif_mixture_MHLS
Parameters to be estimated.
asc_car = Beta('asc_car', 0, None, None, 0)
asc_train = Beta('asc_train', 0, None, None, 0)
asc_sm = Beta('asc_sm', 0, None, None, 1)
b_cost = Beta('b_cost', 0, None, None, 0)
Define a random parameter, normally distributed, designed to be used for Monte-Carlo simulation.
b_time = Beta('b_time', 0, None, None, 0)
It is advised not to use 0 as starting value for the following parameter.
b_time_s = Beta('b_time_s', 1, None, None, 0)
Define a random parameter, uniformly distributed, designed to be used
for Monte-Carlo simulation. The type of draws is set to NORMAL_MLHS
.
b_time_rnd = b_time + b_time_s * Draws('b_time_rnd', 'NORMAL_MLHS')
Definition of the utility functions.
v_train = asc_train + b_time_rnd * TRAIN_TT_SCALED + b_cost * TRAIN_COST_SCALED
v_swissmetro = asc_sm + b_time_rnd * SM_TT_SCALED + b_cost * SM_COST_SCALED
v_car = asc_car + b_time_rnd * CAR_TT_SCALED + b_cost * CAR_CO_SCALED
Associate utility functions with the numbering of alternatives.
v = {1: v_train, 2: v_swissmetro, 3: v_car}
Associate the availability conditions with the alternatives.
av = {1: TRAIN_AV_SP, 2: SM_AV, 3: CAR_AV_SP}
Conditional on b_time_rnd, we have a logit model (called the kernel).
conditional_probability = logit(v, av, CHOICE)
We integrate over b_time_rnd using Monte-Carlo
log_probability = log(MonteCarlo(conditional_probability))
Create the Biogeme object.
the_biogeme = BIOGEME(database, log_probability, number_of_draws=10000, seed=1223)
the_biogeme.model_name = '06unif_mixture_MHLS'
Biogeme parameters read from biogeme.toml.
Estimate the parameters.
results = the_biogeme.estimate()
*** Initial values of the parameters are obtained from the file __06unif_mixture_MHLS.iter
Parameter values restored from __06unif_mixture_MHLS.iter
Starting values for the algorithm: {'asc_train': -0.40185858631652444, 'b_time': -2.259754033646597, 'b_time_s': 1.6570229365550726, 'b_cost': -1.2854433011000461, 'asc_car': 0.13702090018261726}
As the model is rather complex, we cancel the calculation of second derivatives. If you want to control the parameters, change the algorithm from "automatic" to "simple_bounds" in the TOML file.
Optimization algorithm: hybrid Newton/BFGS with simple bounds [simple_bounds]
** Optimization: BFGS with trust region for simple bounds
Optimization algorithm has converged.
Relative gradient: 2.153834922568635e-06
Cause of termination: Relative gradient = 2.2e-06 <= 6.1e-06
Number of function evaluations: 1
Number of gradient evaluations: 1
Number of hessian evaluations: 0
Algorithm: BFGS with trust region for simple bound constraints
Number of iterations: 0
Optimization time: 0:00:05.924978
Calculate second derivatives and BHHH
File 06unif_mixture_MHLS~00.html has been generated.
File 06unif_mixture_MHLS~00.yaml has been generated.
print(results.short_summary())
Results for model 06unif_mixture_MHLS
Nbr of parameters: 5
Sample size: 6768
Excluded data: 3960
Final log likelihood: -5214.947
Akaike Information Criterion: 10439.89
Bayesian Information Criterion: 10473.99
pandas_results = get_pandas_estimated_parameters(estimation_results=results)
display(pandas_results)
Name Value Robust std err. Robust t-stat. Robust p-value
0 asc_train -0.401859 0.065945 -6.093814 1.102520e-09
1 b_time -2.259754 0.117179 -19.284630 0.000000e+00
2 b_time_s 1.657023 0.132669 12.489949 0.000000e+00
3 b_cost -1.285443 0.086294 -14.896028 0.000000e+00
4 asc_car 0.137021 0.051739 2.648291 8.089997e-03
Total running time of the script: (3 minutes 2.399 seconds)