tracts.driver_utils._print_step_header_block#

_print_step_header_block(parameter_handler, start_params_list=None, bound_func=None, title_message=None, display_param_indices=None)#

Print starting-parameter information before optimization runs begin.

This helper is for internal use only. It prints a starting-parameter table that is logged and shown once before optimization runs begin.

Parameters:

  • parameter_handler (FixedParametersHandler) – Used to derive parameter labels and convert optimizer-space values for display.

  • start_params_list (list[ndarray] | None) – Starting parameters in optimizer units. If provided together with bound_func, a starting-parameters table is printed.

  • bound_func (Optional[Callable[[ndarray], float]]) – Function returning a violation score in optimizer space. Used to flag out-of-bounds starting values when printing the table.

  • title_message (str | None) – Optional title shown above the starting-parameters table.

  • display_param_indices (list[int] | None) – Indices of parameters to display in the table. If None, defaults to current free-parameter indices from parameter_handler.

Return type:

None