<a id="skfolio-descriptor-forwarddividendtoprice"></a>

# skfolio.descriptor.ForwardDividendToPrice

<a id="skfolio.descriptor.ForwardDividendToPrice"></a>

### *class* skfolio.descriptor.ForwardDividendToPrice

Forward dividend-to-price ratio descriptor.

Computes the ratio of consensus forward twelve-month dividend per share to
split-adjusted close price:

$$
\text{forward\_dividend\_to\_price}(t) =
\frac{\text{dps\_ntm}(t)}{\text{adj\_close}(t)}
$$

Forward dividend-to-price captures the expected income yield based on analyst
consensus forecasts. Because it incorporates forward-looking estimates rather than
trailing accounting data, it reacts more quickly to dividend initiations, cuts or
policy changes. A high ratio identifies firms where analysts expect generous payouts
relative to the current price.

* **Parameters:**
  **None**
* **Attributes:**
  **n_assets_** *int*
  : Number of assets seen during fitting.

  **asset_names_** *ndarray of shape (n_assets,)*
  : Asset names seen during fitting.

### Methods

| [`fit_transform`](#skfolio.descriptor.ForwardDividendToPrice.fit_transform)(X[, y])         | Compute forward dividend-to-price ratios.      |
|--------------------------------------------------------------------------------|------------------------------------------------|
| [`get_metadata_routing`](#skfolio.descriptor.ForwardDividendToPrice.get_metadata_routing)()        | Get metadata routing of this object.           |
| [`get_params`](#skfolio.descriptor.ForwardDividendToPrice.get_params)([deep])            | Get parameters for this estimator.             |
| [`partial_fit_transform`](#skfolio.descriptor.ForwardDividendToPrice.partial_fit_transform)(X[, y]) | Stateless class delegation to `fit_transform`. |
| [`set_params`](#skfolio.descriptor.ForwardDividendToPrice.set_params)(\*\*params)        | Set the parameters of this estimator.          |

#### SEE ALSO
[`DividendToPrice`](https://skfolio.org/generated/skfolio.descriptor.DividendToPrice.html.md#skfolio.descriptor.DividendToPrice)
: Trailing (historical) dividend yield.

### Notes

Unlike `DividendToPrice`, which uses aggregate fundamentals divided by `market_cap`,
this descriptor uses per-share quantities (`dps_ntm / adj_close`). Consensus
estimates from data providers are typically delivered as per-share forecasts, making
per-share the primary form. `dps_ntm` should use the same split-adjustment basis
as `adj_close`.

The aggregate equivalent is:

$$
\frac{\text{dps\_ntm}}{\text{adj\_close}}
= \frac{\text{dps\_ntm} \times \text{shares\_out}}
      {\text{adj\_close} \times \text{shares\_out}}
= \frac{\text{forward\_dividends\_ntm}}{\text{market\_cap}}
$$

### Examples

```pycon
>>> from skfolio.datasets import make_synthetic_characteristics
>>> from skfolio.descriptor import ForwardDividendToPrice
>>>
>>> X = make_synthetic_characteristics()
>>>
>>> descriptor = ForwardDividendToPrice()
>>> forward_dividend_to_price = descriptor.fit_transform(X)
```

<a id="skfolio.descriptor.ForwardDividendToPrice.fit_transform"></a>

#### fit_transform(X, y=None, \*\*fit_params)

Compute forward dividend-to-price ratios.

* **Parameters:**
  **X** *AssetPanel*
  : Input panel containing `dps_ntm` and `adj_close`.

  **y** *None*
  : Ignored. Present for compatibility with scikit-learn’s API.

  **\*\*fit_params** *dict*
  : Additional fit parameters. Ignored.
* **Returns:**
  **forward_dividend_to_price** *ndarray of shape (n_observations, n_assets)*
  : Forward dividend-to-price ratio for each observation and asset.

<a id="skfolio.descriptor.ForwardDividendToPrice.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.descriptor.ForwardDividendToPrice.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.descriptor.ForwardDividendToPrice.partial_fit_transform"></a>

#### partial_fit_transform(X, y=None, \*\*fit_params)

Stateless class delegation to `fit_transform`.

<a id="skfolio.descriptor.ForwardDividendToPrice.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.

