MultiDimensionalBudgetOptimizerWrapper.optimize_budget

MultiDimensionalBudgetOptimizerWrapper.optimize_budget(budget, budget_bounds=None, response_variable='total_media_contribution_original_scale', utility_function=<function average_response>, constraints=(), default_constraints=True, budgets_to_optimize=None, budget_distribution_over_period=None, callback=False, **minimize_kwargs)

Optimize the budget allocation for the model.

Parameters:

budgetfloat | int

Total budget to allocate.

budget_boundsxr.DataArray | None

Budget bounds per channel.

response_variablestr

Response variable to optimize.

utility_functionUtilityFunctionType

Utility function to maximize.

constraintsSequence[dict[str, Any]]

Custom constraints for the optimizer.

default_constraintsbool

Whether to add default constraints.

budgets_to_optimizexr.DataArray | None

Mask defining which budgets to optimize.

budget_distribution_over_periodxr.DataArray | None

Distribution factors for budget allocation over time. Should have dims (“date”, *budget_dims) where date dimension has length num_periods. Values along date dimension should sum to 1 for each combination of other dimensions. If None, budget is distributed evenly across periods.

callbackbool

Whether to return callback information tracking optimization progress.

**minimize_kwargs

Additional arguments for the optimizer.

Returns:

tuple

Optimal budgets and optimization result. If callback=True, also returns a list of dictionaries with optimization information at each iteration.