.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/sampling/flycheck_plot_b01logit.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_sampling_flycheck_plot_b01logit.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_sampling_flycheck_plot_b01logit.py:


Logit
=====

Estimation of a logit model using sampling of alternatives.

:author: Michel Bierlaire
:date: Wed Nov  1 17:39:47 2023

.. GENERATED FROM PYTHON SOURCE LINES 11-29

.. code-block:: default


    import pandas as pd
    from biogeme.sampling_of_alternatives import (
        SamplingContext,
        ChoiceSetsGeneration,
        GenerateModel,
        generate_segment_size,
    )
    import biogeme.biogeme_logging as blog
    import biogeme.biogeme as bio
    from compare import compare
    from specification import V, combined_variables
    from alternatives import (
        alternatives,
        ID_COLUMN,
        partitions,
    )


.. GENERATED FROM PYTHON SOURCE LINES 30-32

.. code-block:: default

    logger = blog.get_screen_logger(level=blog.INFO)


.. GENERATED FROM PYTHON SOURCE LINES 33-35

The data file contains several columns associated with synthetic
choices. Here we arbitrarily select `logit_4`.

.. GENERATED FROM PYTHON SOURCE LINES 35-37

.. code-block:: default

    CHOICE_COLUMN = 'logit_4'


.. GENERATED FROM PYTHON SOURCE LINES 38-44

.. code-block:: default

    SAMPLE_SIZE = 10
    PARTITION = 'asian'
    MODEL_NAME = f'logit_{PARTITION}_{SAMPLE_SIZE}_alt'
    FILE_NAME = f'{MODEL_NAME}.dat'
    OBS_FILE = 'obs_choice.dat'


.. GENERATED FROM PYTHON SOURCE LINES 45-49

.. code-block:: default

    the_partition = partitions.get(PARTITION)
    if the_partition is None:
        raise ValueError(f'Unknown partition: {PARTITION}')


.. GENERATED FROM PYTHON SOURCE LINES 50-52

.. code-block:: default

    segment_sizes = generate_segment_size(SAMPLE_SIZE, the_partition.number_of_segments())


.. GENERATED FROM PYTHON SOURCE LINES 53-55

.. code-block:: default

    observations = pd.read_csv(OBS_FILE)


.. GENERATED FROM PYTHON SOURCE LINES 56-68

.. 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,
    )


.. GENERATED FROM PYTHON SOURCE LINES 69-71

.. code-block:: default

    logger.info(context.reporting())


.. GENERATED FROM PYTHON SOURCE LINES 72-74

.. code-block:: default

    the_data_generation = ChoiceSetsGeneration(context=context)


.. GENERATED FROM PYTHON SOURCE LINES 75-77

.. code-block:: default

    the_model_generation = GenerateModel(context=context)


.. GENERATED FROM PYTHON SOURCE LINES 78-80

.. code-block:: default

    biogeme_database = the_data_generation.sample_and_merge(recycle=False)


.. GENERATED FROM PYTHON SOURCE LINES 81-83

.. code-block:: default

    logprob = the_model_generation.get_logit()


.. GENERATED FROM PYTHON SOURCE LINES 84-87

.. code-block:: default

    the_biogeme = bio.BIOGEME(biogeme_database, logprob)
    the_biogeme.modelName = MODEL_NAME


.. GENERATED FROM PYTHON SOURCE LINES 88-89

Calculate the null log likelihood for reporting.

.. GENERATED FROM PYTHON SOURCE LINES 89-91

.. code-block:: default

    the_biogeme.calculateNullLoglikelihood({i: 1 for i in range(SAMPLE_SIZE)})


.. GENERATED FROM PYTHON SOURCE LINES 92-93

Estimate the parameters

.. GENERATED FROM PYTHON SOURCE LINES 93-95

.. code-block:: default

    results = the_biogeme.estimate(recycle=False)


.. GENERATED FROM PYTHON SOURCE LINES 96-98

.. code-block:: default

    print(results.short_summary())


.. GENERATED FROM PYTHON SOURCE LINES 99-102

.. code-block:: default

    estimated_parameters = results.getEstimatedParameters()
    estimated_parameters


.. GENERATED FROM PYTHON SOURCE LINES 103-105

.. code-block:: default

    df, msg = compare(estimated_parameters)


.. GENERATED FROM PYTHON SOURCE LINES 106-108

.. code-block:: default

    print(df)


.. GENERATED FROM PYTHON SOURCE LINES 109-110

.. code-block:: default

    print(msg)


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.000 seconds)


.. _sphx_glr_download_auto_examples_sampling_flycheck_plot_b01logit.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example




    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: flycheck_plot_b01logit.py <flycheck_plot_b01logit.py>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: flycheck_plot_b01logit.ipynb <flycheck_plot_b01logit.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_