.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "auto_examples/sampling/plot_b03cnl.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_auto_examples_sampling_plot_b03cnl.py: Cross-nested logit ================== Estimation of a cross-nested logit model using sampling of alternatives. :author: Michel Bierlaire :date: Wed Nov 1 18:00:33 2023 .. GENERATED FROM PYTHON SOURCE LINES 11-34 .. code-block:: default import pandas as pd from biogeme.sampling_of_alternatives import ( SamplingContext, ChoiceSetsGeneration, GenerateModel, generate_segment_size, ) from biogeme.expressions import Beta import biogeme.biogeme_logging as blog import biogeme.biogeme as bio from biogeme.nests import OneNestForCrossNestedLogit, NestsForCrossNestedLogit from specification import V, combined_variables from compare import compare from alternatives import ( alternatives, ID_COLUMN, partitions, all_alternatives, asian_and_downtown, only_downtown, only_asian, ) .. GENERATED FROM PYTHON SOURCE LINES 35-37 .. code-block:: default logger = blog.get_screen_logger(level=blog.INFO) .. GENERATED FROM PYTHON SOURCE LINES 38-46 .. code-block:: default PARTITION = 'downtown' MEV_PARTITION = 'uniform_asian_or_downtown' SAMPLE_SIZE = 10 # out of 100 alternatives SAMPLE_SIZE_MEV = 63 # out of 63 alternatives CHOICE_COLUMN = 'cnl_3' MODEL_NAME = f'cnl_{SAMPLE_SIZE}_{SAMPLE_SIZE_MEV}' FILE_NAME = f'{MODEL_NAME}.dat' .. GENERATED FROM PYTHON SOURCE LINES 47-51 .. code-block:: default the_partition = partitions.get(PARTITION) if the_partition is None: raise ValueError(f'Unknown partition: {PARTITION}') .. GENERATED FROM PYTHON SOURCE LINES 52-56 .. code-block:: default segment_sizes = list( generate_segment_size(SAMPLE_SIZE, the_partition.number_of_segments()) ) .. GENERATED FROM PYTHON SOURCE LINES 57-58 We use all alternatives in the nest. .. GENERATED FROM PYTHON SOURCE LINES 58-65 .. code-block:: default mev_partition = partitions.get(MEV_PARTITION) if mev_partition is None: raise ValueError(f'Unknown partition: {MEV_PARTITION}') mev_segment_sizes = [ SAMPLE_SIZE_MEV, ] .. GENERATED FROM PYTHON SOURCE LINES 66-67 Nests .. GENERATED FROM PYTHON SOURCE LINES 69-70 Downtown .. GENERATED FROM PYTHON SOURCE LINES 70-78 .. code-block:: default mu_downtown = Beta('mu_downtown', 1, 1, None, 0) downtown_alpha_dict = {i: 0.5 for i in asian_and_downtown} | { i: 1 for i in only_downtown } downtown_nest = OneNestForCrossNestedLogit( nest_param=mu_downtown, dict_of_alpha=downtown_alpha_dict, name='downtown' ) .. GENERATED FROM PYTHON SOURCE LINES 79-80 Asian .. GENERATED FROM PYTHON SOURCE LINES 80-91 .. code-block:: default mu_asian = Beta('mu_asian', 1, 1, None, 0) asian_alpha_dict = {i: 0.5 for i in asian_and_downtown} | {i: 1.0 for i in only_asian} asian_nest = OneNestForCrossNestedLogit( nest_param=mu_asian, dict_of_alpha=asian_alpha_dict, name='asian' ) cnl_nests = NestsForCrossNestedLogit( choice_set=all_alternatives, tuple_of_nests=(downtown_nest, asian_nest), ) .. GENERATED FROM PYTHON SOURCE LINES 92-94 .. code-block:: default observations = pd.read_csv('obs_choice.dat') .. GENERATED FROM PYTHON SOURCE LINES 95-110 .. code-block:: default context = SamplingContext( the_partition=the_partition, sample_sizes=segment_sizes, individuals=observations, choice_column=CHOICE_COLUMN, alternatives=alternatives, id_column=ID_COLUMN, biogeme_file_name=FILE_NAME, utility_function=V, combined_variables=combined_variables, mev_partition=mev_partition, mev_sample_sizes=mev_segment_sizes, cnl_nests=cnl_nests, ) .. GENERATED FROM PYTHON SOURCE LINES 111-113 .. code-block:: default logger.info(context.reporting()) .. rst-class:: sphx-glr-script-out .. code-block:: none Size of the choice set: 100 Main partition: 2 segment(s) of size 46, 54 Main sample: 10: 5/46, 5/54 Nbr of MEV alternatives: 63 MEV partition: 1 segment(s) of size 63 MEV sample: 63: 63/63 .. GENERATED FROM PYTHON SOURCE LINES 114-117 .. code-block:: default the_data_generation = ChoiceSetsGeneration(context=context) the_model_generation = GenerateModel(context=context) .. GENERATED FROM PYTHON SOURCE LINES 118-120 .. code-block:: default biogeme_database = the_data_generation.sample_and_merge(recycle=False) .. rst-class:: sphx-glr-script-out .. code-block:: none Generating 10 + 63 alternatives for 10000 observations 0%| | 0/10000 [00:00
Value Rob. Std err Rob. t-test Rob. p-value
beta_chinese 0.765983 0.060207 12.722451 0.0
beta_ethiopian 0.526412 0.041496 12.685779 0.0
beta_french 0.777741 0.049470 15.721391 0.0
beta_indian 1.097405 0.052229 21.011339 0.0
beta_japanese 1.296880 0.046115 28.122891 0.0
beta_korean 0.811152 0.053094 15.277640 0.0
beta_lebanese 0.755723 0.048377 15.621583 0.0
beta_log_dist -0.586730 0.012674 -46.292851 0.0
beta_mexican 1.241028 0.030040 41.312755 0.0
beta_price -0.420492 0.012436 -33.811212 0.0
beta_rating 0.746966 0.015039 49.667319 0.0
mu_asian 2.123777 0.067253 31.578949 0.0
mu_downtown 1.930837 0.030021 64.316050 0.0


.. GENERATED FROM PYTHON SOURCE LINES 143-145 .. code-block:: default df, msg = compare(estimated_parameters) .. GENERATED FROM PYTHON SOURCE LINES 146-148 .. code-block:: default print(df) .. rst-class:: sphx-glr-script-out .. code-block:: none Name True Value Estimated Value T-Test 0 beta_rating 0.75 0.746966 0.201726 1 beta_price -0.40 -0.420492 1.647755 2 beta_chinese 0.75 0.765983 -0.265467 3 beta_japanese 1.25 1.296880 -1.016593 4 beta_korean 0.75 0.811152 -1.151761 5 beta_indian 1.00 1.097405 -1.864958 6 beta_french 0.75 0.777741 -0.560769 7 beta_mexican 1.25 1.241028 0.298658 8 beta_lebanese 0.75 0.755723 -0.118305 9 beta_ethiopian 0.50 0.526412 -0.636482 10 beta_log_dist -0.60 -0.586730 -1.046964 11 mu_asian 2.00 2.123777 -1.840468 12 mu_downtown 2.00 1.930837 2.303824 .. GENERATED FROM PYTHON SOURCE LINES 149-150 .. code-block:: default print(msg) .. rst-class:: sphx-glr-timing **Total running time of the script:** (6 minutes 12.700 seconds) .. _sphx_glr_download_auto_examples_sampling_plot_b03cnl.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: plot_b03cnl.py ` .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: plot_b03cnl.ipynb ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_