bayesline.api.equity.FlowColumnSettings

bayesline.api.equity.FlowColumnSettings#

model FlowColumnSettings#

A quantity a book earns over dates: its PnL.

A flow compounds only as a return, so dates="compound" needs denominator="net" wherever both are set; dates="sum_over_window" divides by a statistic, so it needs denominator to be net or gross; and denominator="gross" needs leg="portfolio".

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[‘flow’]

No

'flow'

leg

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

No

None

link

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

No

None

metric

MetricT

Yes

reference

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

No

None

field dates: Literal['sum', 'compound', 'sum_over_window'] | Default [Optional]#
field denominator: Literal['none', 'net', 'gross'] | Default [Optional]#
field kind: Literal['flow'] [Optional]#
field leg: Literal['portfolio', 'benchmark', 'active'] | Default [Optional]#
field metric: MetricT [Required]#
field reference: Literal['own', 'root'] | Default [Optional]#