paraqeet.optimizers.optimizer.OptimizationResult#
- class paraqeet.optimizers.optimizer.OptimizationResult(status, value, iterations, message=None, raw_result=None)[source]#
Bases:
objectData class for representing optimization results.
- Parameters:
status (int)
value (float)
iterations (int)
message (str | None)
raw_result (Any | None)
- STATUS_FINISHED#
The optimization finished without a clear success or failure. This is used by algorithms that do not necessarily converge towards a solution.
- Type:
int
- STATUS_SUCCESS#
The optimization successfully found an optimum.
- Type:
int
- STATUS_FAILED#
The optimization failed to converge.
- Type:
int
- status#
Indicates if the optimization was successful. Should have one of the status constants as value.
- Type:
int
- value#
The value at the best point of the optimized function.
- Type:
float
- iterations#
The number of iterations during the optimization.
- Type:
int
- message#
Any additional message from the optimization algorithm. This can be an error message in case of failure.
- Type:
str | None, optional
- raw_result#
The raw result from the underlying algorithm.
- Type:
Any | None, optional
- __init__(status, value, iterations, message=None, raw_result=None)#
- Parameters:
status (int)
value (float)
iterations (int)
message (str | None)
raw_result (Any | None)
- Return type:
None
Methods
__init__(status, value, iterations[, ...])Attributes