Read of estimate

Function to estimate the parameters, or read them from a file, if available.

Michel Bierlaire, EPFL Mon May 05 2025, 18:59:34

from biogeme.biogeme import BIOGEME
from biogeme.results_processing import EstimationResults


def read_or_estimate(
    the_biogeme: BIOGEME, run_bootstrap: bool = False, directory: str = '.'
) -> EstimationResults:
    """
    Function to estimate the parameters, or read them from a file, if available.

    :param the_biogeme: Biogeme object.
    :param directory: directory where the yaml file is supposed to be.

    :return: estimation results.
    """
    try:
        filename = f'{directory}/{the_biogeme.model_name}.yaml'
        results = EstimationResults.from_yaml_file(filename=filename)
        print(f'Results are read from the file {filename}.')
    except FileNotFoundError:
        print('Parameters are being estimated.')
        results = the_biogeme.estimate(run_bootstrap=run_bootstrap)
    return results