gemseo.mlearning.linear_model_fitting.base_linear_model_fitter_settings module#

Base settings for linear model fitting algorithms.

Settings BaseLinearModelFitter_Settings(*, fit_intercept=True)[source]#

Base settings for linear model fitting algorithms.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

fit_intercept (bool) --

By default it is set to True.

Return type:

None

fit_intercept: bool = True#

Whether to calculate the intercept \(b\) in the linear model \(y=Ax+b\). Otherwise, it is assumed to be zero.

This option is ignored in presence of extra data, e.g., Jacobian observations; the intercept \(b\) is assumed to be zero.