larch.numba.Model.parameter_summary

larch.numba.Model.parameter_summary

Model.parameter_summary(self, output='df')

Create a tabular summary of parameter values.

This will generate a small table of parameters statistics, containing:

  • Parameter Name (and Category, if applicable)

  • Estimated Value

  • Standard Error of the Estimate (if known)

  • t Statistic (if known)

  • Null Value

  • Binding Constraints (if applicable)

Parameters

output ({'df','xml'}) – The format of the output. The default, ‘df’, creates a pandas DataFrame. Alternatively, use ‘xml’ to create a table as a xmle.Elem (this format is no longer preferred).

Returns

pandas.DataFrame or xmle.Elem