bayesline.api.equity.ContributionColumnSettings

bayesline.api.equity.ContributionColumnSettings#

model ContributionColumnSettings#

A cell’s contribution to the predicted risk of the book it is measured against.

Taken in risk or per unit of that book’s variance; either way it carries the name split. denominator="gross" needs leg="portfolio" wherever both are set.

Fields#

Field

Type

Required

Default

denominator

Literal[‘none’, ‘net’, ‘gross’] | Default

No

None

kind

Literal[‘contribution’]

No

'contribution'

leg

Literal[‘portfolio’, ‘benchmark’, ‘active’] | Default

No

None

metric

MetricT

Yes

name_contribution_basis

Literal[‘Grinold-Kahn’, ‘Menchero-Davis’] | Default

No

None

reference

Literal[‘own’, ‘root’] | Default

No

None

field denominator: Literal['none', 'net', 'gross'] | Default [Optional]#
field kind: Literal['contribution'] [Optional]#
field leg: Literal['portfolio', 'benchmark', 'active'] | Default [Optional]#
field metric: MetricT [Required]#
field name_contribution_basis: Literal['Grinold-Kahn', 'Menchero-Davis'] | Default [Optional]#
field reference: Literal['own', 'root'] | Default [Optional]#