bayesline.api.equity.BrinsonColumnSettings

bayesline.api.equity.BrinsonColumnSettings#

model BrinsonColumnSettings#

A Brinson allocation, selection or interaction effect of the active book.

Each day, each group i of the queried assets has start-of-day weights w_P = N_P(i) / N_P(R) and w_B = N_B(i) / N_P(R) and returns r_P = PnL_P(i) / N_P(i) and r_B = PnL_B(i) / N_B(i), where N is the start-of-day NAV of a leg’s holdings, R the reference book, and the benchmark is carried onto the portfolio’s NAV; the reference book’s own returns r_P(R) and r_B(R) are its two PnLs over N_P(R), so NAV the benchmark does not cover is cash. Under Brinson-Fachler, allocation is (w_P - w_B) (r_B - r_B(R)); under Brinson-Hood-Beebower it is (w_P - w_B) r_B. Selection is w_B (r_P - r_B) and interaction (w_P - w_B) (r_P - r_B) under both. Over groups that partition the reference book the three effects add to its active return r_P(R) - r_B(R), under Brinson-Fachler where the benchmark covers the whole NAV, so an effect is not additive over a partial set of groups. Where the benchmark holds nothing in a group, its return there is taken as r_B(R), and where the portfolio holds nothing, as r_P(R); a group neither leg holds has every effect zero. A book with no benchmark has every effect NaN, and a fully benchmarked book that is its own reference, taken as one group, has zero allocation and interaction and a selection equal to its active return.

denominator="net" gives the effects as returns on the reference’s NAV, none in currency, each times N_P(R), and gross as currency over the reference’s gross. dates="sum" adds the daily effects; dates="compound" links them with the named link against the reference’s two daily returns, so it needs denominator="net" and one of carino, menchero or frongello wherever both are set. An effect is not summed over its window. variant names the decomposition.

Fields#

Field

Type

Required

Default

dates

Literal[‘sum’, ‘compound’, ‘sum_over_window’] | Default

No

None

denominator

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

No

None

kind

Literal[‘brinson’]

No

'brinson'

link

Literal[‘book_difference’, ‘carino’, ‘menchero’, ‘frongello’] | Default

No

None

metric

MetricT

Yes

reference

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

No

None

variant

Literal[‘Brinson-Fachler’, ‘Brinson-Hood-Beebower’] | Default

No

None

field dates: Literal['sum', 'compound', 'sum_over_window'] | Default [Optional]#
field denominator: Literal['none', 'net', 'gross'] | Default [Optional]#
field kind: Literal['brinson'] [Optional]#
field metric: MetricT [Required]#
field reference: Literal['own', 'root'] | Default [Optional]#
field variant: Literal['Brinson-Fachler', 'Brinson-Hood-Beebower'] | Default [Optional]#