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"needsdenominator="net"wherever both are set;dates="sum_over_window"divides by a statistic, so it needsdenominatorto benetorgross; anddenominator="gross"needsleg="portfolio".Fields# Field
Type
Required
Default
Literal[‘sum’, ‘compound’, ‘sum_over_window’] |DefaultNo
NoneLiteral[‘none’, ‘net’, ‘gross’] |DefaultNo
NoneLiteral[‘flow’]No
'flow'Literal[‘portfolio’, ‘benchmark’, ‘active’] |DefaultNo
NoneLiteral[‘book_difference’, ‘carino’, ‘menchero’, ‘frongello’] |DefaultNo
NoneMetricTYes
Literal[‘own’, ‘root’] |DefaultNo
None- field metric: MetricT [Required]#