Result¶

class ionworkspipeline.Result(parameter_values, optimizer_result, callbacks=None, callback_results=None, children=None)¶

A class to store the results of a ionworkspipeline.DataFit.

Parameters¶

parameter_valuesdict: The final values of the optimized parameters.
optimizer_resultscipy.optimize.OptimizeResult: The result object returned by the SciPy optimizer.
callbacksdict: The callbacks used during optimization.
callback_resultsdict: The results collected by callbacks during optimization.
childrendict, optional: Results from multistarted parameter estimation if applicable.

Attributes¶

parameter_valuesdict

The final values of the optimized parameters.

optimizer_resultscipy.optimize.OptimizeResult

The result object in the format returned by the SciPy optimizer.

callbacksdict

The callbacks used during optimization.

callback_resultsdict

The results collected by callbacks during optimization, formatted as follows:

{
    "callback_name": {
        "data": ...,
        "options": ...,
        "initial_results": {
            "inputs": ...,
            "outputs": ...,
        },
        "fit_results": {
            "inputs": ...,
            "outputs": ...,
        },
    },
    ...
}

childrendict

Results from sub-fits if this was part of a composite fit.

Notes¶

The specific attributes available in optimizer_result may vary depending on the optimization method used. Refer to SciPy’s documentation for a complete list of possible attributes.

Extends: builtins.dict