on_iteration_end

FileLogger.on_iteration_end(project, iteration: int, params: ndarray, fom_value: float, gradient: ndarray | None = None, **kwargs) → None

Record one iteration-completion row in the data file.

The row uses an ITER prefix (no leading indent) so iteration boundaries stand out visually from the indented per-eval rows. When log_gradients is enabled and a gradient is supplied, an additional # Gradient: ... row follows with the gradient norm and component vector.

Parameters:

projectProject

The optimization project.

iterationint

Iteration number.

paramsnp.ndarray

Parameter values at the end of this iteration.

fom_valuefloat

FOM value at the end of this iteration.

gradientnp.ndarray, optional

Gradient at the end of this iteration; emitted on its own row when log_gradients is enabled.

**kwargs

Additional information (currently unused).