<a id="skfolio-prior-baseprior"></a>

# skfolio.prior.BasePrior

<a id="skfolio.prior.BasePrior"></a>

### *class* skfolio.prior.BasePrior

Base class for all prior estimators in skfolio.

### Methods

| [`fit`](#skfolio.prior.BasePrior.fit)(X[, y])            | Fit the prior estimator and set `return_distribution_`.   |
|-------------------------------------------------------------------------|-----------------------------------------------------------|
| [`get_metadata_routing`](#skfolio.prior.BasePrior.get_metadata_routing)() | Get metadata routing of this object.                      |
| [`get_params`](#skfolio.prior.BasePrior.get_params)([deep])     | Get parameters for this estimator.                        |
| [`set_params`](#skfolio.prior.BasePrior.set_params)(\*\*params) | Set the parameters of this estimator.                     |

### Notes

All estimators should specify all the parameters that can be set
at the class level in their `__init__` as explicit keyword
arguments (no `*args` or `**kwargs`).

<a id="skfolio.prior.BasePrior.fit"></a>

#### *abstractmethod* fit(X, y=None, \*\*fit_params)

Fit the prior estimator and set `return_distribution_`.

* **Parameters:**
  **X** *array-like of shape (n_observations, n_assets)*
  : Price returns of the assets.

  **y** *Ignored*
  : Not used, present for API consistency by convention.

  **\*\*fit_params** *dict*
  : Parameters to pass to the underlying estimators.
    Only available if `enable_metadata_routing=True`, which can be
    set by using `sklearn.set_config(enable_metadata_routing=True)`.
    See [Metadata Routing User Guide](https://skfolio.org/user_guide/metadata_routing.html.md#metadata-routing) for
    more details.
* **Returns:**
  **self** *BasePrior*
  : Fitted estimator.

<a id="skfolio.prior.BasePrior.get_metadata_routing"></a>

#### get_metadata_routing()

Get metadata routing of this object.

Please check [User Guide](https://skfolio.org/user_guide/metadata_routing.html.md#metadata-routing) on how the routing
mechanism works.

* **Returns:**
  **routing** *MetadataRequest*
  : A `MetadataRequest` encapsulating
    routing information.

<a id="skfolio.prior.BasePrior.get_params"></a>

#### get_params(deep=True)

Get parameters for this estimator.

* **Parameters:**
  **deep** *bool, default=True*
  : If True, will return the parameters for this estimator and
    contained subobjects that are estimators.
* **Returns:**
  **params** *dict*
  : Parameter names mapped to their values.

<a id="skfolio.prior.BasePrior.set_params"></a>

#### set_params(\*\*params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects
(such as `Pipeline`). The latter have
parameters of the form `<component>__<parameter>` so that it’s
possible to update each component of a nested object.

* **Parameters:**
  **\*\*params** *dict*
  : Estimator parameters.
* **Returns:**
  **self** *estimator instance*
  : Estimator instance.