bayesline.api.equity.FactorModelReportSettings

bayesline.api.equity.FactorModelReportSettings#

model FactorModelReportSettings#

Report settings that run on a factor risk model.

The factor risk model may be embedded inline or referenced by the name or id of saved factor risk model settings. References are resolved when the report is loaded; results derived from a referenced model are shared at the referenced settings’ owner level, while an inline model keeps the report private to the executing user.

Fields#

Field

Type

Required

Default

factor_model_settings

str | int | FactorRiskModelSettings

Yes

report_type

str

Yes

field factor_model_settings: str | int | FactorRiskModelSettings [Required]#

The factor risk model to run the report on: either inline settings or a reference (name or id) to saved factor risk model settings.

field report_type: str [Required]#

Discriminator field for report type