traveler.steps.simple_choice.calibrate_analytic_share#

simple_choice.calibrate_analytic_share(store, *, choosers=None, param=None, target_shares, calib_params, scale=1.0, method=None)[source]#

Calibrate selected parameters to match target alternative shares.

Parameters:

  • store (AbstractStore) – Store containing chooser and supporting model data.

  • choosers (WorkingTable or None, optional) – Choosers used for calibration. When omitted, use the configured table.

  • param (dict[str, float] or None, optional) – Parameter values to merge into the model before calibration.

  • target_shares (dict or jax.Array) – Target share for each configured alternative.

  • calib_params (collections.abc.Sequence[str]) – Names of parameters the optimizer may change.

  • scale (float, optional) – Multiplier applied to the share loss.

  • method (str, callable, or None, optional) – Optimization method passed to scipy.optimize.minimize().

Returns:

Optimizer result augmented with the final modeled shares.

Return type:

scipy.optimize.OptimizeResult