gemseo.mlearning.regression.algos.fce_settings module

Settings of the functional chaos expansion model.

Settings FCERegressor_Settings(*, transformer=<factory>, parameters=<factory>, input_names=(), output_names=(), degree=2, learn_jacobian_data=False, use_special_jacobian_data=False, linear_model_fitter_settings=None, basis=OrthonormalFunctionBasis.POLYNOMIAL)

Bases: BaseFCERegressor_Settings

The settings of the functional chaos expansion model.

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:

• transformer (Mapping[str, Any]) --

  By default it is set to <factory>.

• parameters (Mapping[str, Any]) --

  By default it is set to <factory>.

• input_names (Sequence[str]) --

  By default it is set to ().

• output_names (Sequence[str]) --

  By default it is set to ().

• degree (Annotated[int, Gt(gt=0)]) --

  By default it is set to 2.

• learn_jacobian_data (bool) --

  By default it is set to False.

• use_special_jacobian_data (bool) --

  By default it is set to False.

• linear_model_fitter_settings (BaseLinearModelFitter_Settings | None)

• basis (OrthonormalFunctionBasis) --

  By default it is set to "Polynomial".

Return type:

None

basis: OrthonormalFunctionBasis = OrthonormalFunctionBasis.POLYNOMIAL

The orthonormal function basis.

linear_model_fitter_settings: BaseLinearModelFitter_Settings | None = None

The settings of the linear solver. If None, use the default OrthogonalMatchingPursuit_Settings.

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) -- The BaseModel instance.

• context (Any) -- The context.

Return type:

None

class OrthonormalFunctionBasis(*values)

Bases: StrEnum

An orthonormal function basis.

FOURIER = 'Fourier'

HAAR = 'Haar'

POLYNOMIAL = 'Polynomial'