folie.Overdamped¶
- class folie.Overdamped(drift, diffusion=None, dim=None, **kwargs)[source]¶
A class that implement a overdamped model with given functions for space dependency
The evolution equation for variable X(t) is defined as
\[\mathrm{d}X(t) = F(X)\mathrm{d}t + \sigma(X)\mathrm{d}W_t\]The components of the overdamped model are the drift profile F(X) as well as the diffusion \(D(x) = \frac{1}{2} \sigma(X)\sigma(X)^T\)
When considering equilibrium models, the drift and diffusion profile are related to the free energy profile V(X) via
\[F(x) = -D(x) \nabla V(x) + \mathrm{div} D(x)\]- Parameters:
- drift, diffusionFunctions
Functions for the spatial dependance of the drift \(F(x)\) and diffusion \(D(x)\). If diffusion is not given it default to the copy of drift
- dimint
Dimension of the model. By default it is the dimension of the domain of the drift
- has_bias: None, bool
If None, assume no bias in the data. If true, this assume that an extra column is present in the data
- get_params(deep=False)[source]¶
Get the parameters.
- Returns:
- paramsmapping of string to any
Parameter names mapped to their values.
- set_params(**params)[source]¶
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form
<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfobject
Estimator instance.
- property coefficients¶
Access the coefficients
- property coefficients_drift¶
Access the coefficients
- property coefficients_drift_biased¶
Access the coefficients
- property dim¶
Dimensionnality of the model
